HIhightouch

Update Sync

Changed on

Update an existing sync

Patch a sync based on its Hightouch ID. A sync bound to a sync template takes its configuration from the template: change this sync's values with syncTemplateOverrides, bind it to another template or detach it with syncTemplateId, but do not set configuration while it is bound. In a workspace that requires sync templates for audience activation, a sync on an audience cannot be detached from its template.

patch/syncs/{syncId}

Request

  • Base URL
    https://api.hightouch.com/api/v1
  • Auth
    HTTP bearer

Path parameters

syncIdnumber double required

The sync's ID

Request body

configurationobject

The sync's configuration. This specifies how data is mapped, among other configuration.

The schema depends on the destination type.

For a sync bound to a sync template this is the effective configuration: the template's configuration with this sync's syncTemplateOverrides applied.

Consumers should NOT make assumptions on the contents of the configuration. It may change as Hightouch updates its internal code.

disabledboolean

Whether the sync has been disabled by the user.

syncTemplateIdnumber double nullable

The id of a Sync Template to bind the sync to, or null to detach the sync from its template. Binding requires the template's destination to match the sync's destination; while bound, the sync follows the template's configuration and configuration cannot be set directly. Detaching copies the sync's effective configuration, schedule and other inherited settings onto the sync so it keeps running unchanged.

syncTemplateOverridesobject nullable

Replaces the sync's template overrides, keyed by configuration field path. Only fields the template's overrideConfig marks as overridable are accepted; null clears every override. Requires the sync to be, or to become, bound to a sync template.

Response

Ok

OR
OR
'Internal Server Error' required

Changes

  • 2e05cc6b427bRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status

  • 5574262d4032Revision changes
    • info

      added the required property //// to the response with the status

    • info

      added the required property //// to the response with the status