Antony REST icon

Antony REST

Call known Antony REST API operations

Actions159

CardDAV → Create CardDAV Sync

AI-generated

Summary

Create a new CardDAV synchronization configuration by sending a JSON or form-mode body payload to the /api/v1/carddav endpoint of the Antony API.

Inputs

  • Body Input Mode (required) — Select whether to provide the sync configuration as raw JSON or as individual form fields.
  • Body JSON (required) — The CardDAV Sync JSON object specifying the synchronization settings, used when 'Body Input Mode' is JSON.
  • Body Parameters (required) — One or more name-value pairs representing the parameters of the sync configuration, used when 'Body Input Mode' is Form Fields.

Output shape

a list of JSON items representing the created CardDAV sync configuration as returned by the API

The operation sends a POST request to the /api/v1/carddav endpoint with the specified body. The response JSON is normalized to output items. Errors during execution throw exceptions unless 'Continue On Fail' is enabled, in which case error details are output as JSON.

Examples

Example 1: Create CardDAV Sync with JSON Body

Provide the full CardDAV sync configuration as JSON in the 'Body JSON' field with 'Body Input Mode' set to 'JSON'. The node will POST this to create the sync and output the created sync details.

Example 2: Create CardDAV Sync with Form Fields

Set 'Body Input Mode' to 'Form Fields' and specify each sync parameter as a name-value pair in 'Body Parameters'. The node sends these form fields as the request body to create the sync, outputting the created sync details.

Links

Discussion