PATCH

Update Sync Config

Updates the import and export settings for an external calendar connection's events.

A connection's syncConfig object determines:

  • Whether events from 1 or more accounts belonging to the external calendar are imported to the connected Wix schedule. (SDK | REST). If importing events is enabled, you can call List Events (SDK | REST) to retrieve external calendar events.
  • Whether events from the Wix schedule are exported to 1 or more accounts belonging to the external calendar.

To check the current import and export settings, you can call Get Connection (SDK | REST) or List Connections (SDK | REST).

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Bookings - all permissions
Manage External Calendars
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/bookings/v2/external-calendars/connections/{connectionId}/sync-config
Path Params
connectionIdstringRequired

ID of the external calendar connection to update.

Body Params
syncConfigSyncConfigRequired

Updated sync configuration details.

Response Object
connectionConnection

Connection with updated sync configuration.

Request
cURL
curl -X PATCH 'https://www.wixapis.com/bookings/v2/external-calendars/connections/4WnvD8QzxhkAjVPBKUCvLIMpbuuUCMID7rYhqOpIGDae9JYyQj0JS71sdJukve86B38sWvS6TOvMQqBxszjEMNrrx8EGfFr5KhzpkCmfjBNJx2MSLZEkgEzGqEHtRYJ92LTUJ2w5v87FG2DafDaN3VSfbRlvSEqzXlgbEapLhGsm976gGw90KJd/sync-config' \
-H 'Authorization: <AUTH>' \
-H 'Content-Type: application/json' \
--data-raw '{
    "syncConfig": {
        "listEventFromCalendars": {
            "enabled": true,
            "calendars": {
                "calendars": [
                    {
                        "id": "a68yu6lp6584z66zorp19z1ab"
                    },
                    {
                        "id": "4xve0tohyhnrlzy3lp4zf7b07"
                    }
                ]
            }
        }
    }
}'
Response
JSON
{
  "connection": {
    "id": "4WnvD8QzxhkAjVPBKUCvLIMpbuuUCMID7rYhqOpIGDae9JYyQj0JS71sdJukve86B38sWvS6TOvMQqBxszjEMNrrx8EGfFr5KhzpkCmfjBNJx2MSLZEkgEzGqEHtRYJ92LTUJ2w5v87FG2DafDaN3VSfbRlvSEqzXlgbEapLhGsm976gGw90KJd",
    "providerId": "9f084ae8-b3a6-4eb6-a29d-bc682c04b5fc",
    "calendarType": "I_CAL",
    "scheduleId": "3e47ec65-2975-447c-a7ed-75041e850d5e",
    "userId": "f7f363b1-8ef8-4118-9612-0e6b3910745a",
    "externalAccountEmail": "some@email.com",
    "status": "CONNECTED",
    "syncConfig": {
      "listEventFromCalendars": {
        "enabled": true,
        "calendars": {
          "calendars": [
            {
              "id": "4xve0tohyhnrlzy3lp4zf7b07"
            },
            {
              "id": "a68yu6lp6584z66zorp19z1ab"
            }
          ]
        }
      }
    }
  }
}
Errors
428Failed Precondition

There is 1 error with this status code.

This method may also return standard errors. Learn more about standard Wix errors.

Did this help?