HIhightouch

Create Sync

Changed on

Create a new sync

A sync either owns its configuration (destinationId and configuration) or is created from a sync template (syncTemplateId). A sync created from a template uses the template's destination and configuration, and may set the fields the template's overrideConfig marks as overridable through syncTemplateOverrides. The effective configuration is validated for the destination either way, and configuration.<field> errors on a template sync refer to that merged configuration. In a workspace that requires sync templates for audience activation, a sync on an audience must be created from a sync template.

post/syncs

Request

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

Request body

slugstring required

The sync's slug

modelIdnumber double required

The id of the Model that sync is connected to

disabledboolean required

Whether the sync has been disabled by the user.

destinationIdnumber double

The id of the Destination that sync is connected to. Required unless syncTemplateId is provided: a sync created from a sync template always uses the template's destination, and this field, when provided, must match it.

configurationobject

The sync's configuration. This specifies how data is mapped, among other configuration. The schema depends on the destination type.

Required unless syncTemplateId is provided, in which case it must be omitted: the template provides the configuration and this sync's own values go in syncTemplateOverrides.

syncTemplateIdnumber double

The id of the Sync Template to create the sync from. The sync inherits the template's destination and configuration and follows later changes to the template. A null schedule inherits the template's schedule; a schedule given here belongs to the sync. modelId must be the template's model or an audience built on it.

syncTemplateOverridesobject

Values this sync sets for the template's overridable fields, keyed by configuration field path (for example "externalIdMapping" or "target.schema"). Only fields the template's overrideConfig marks as overridable are accepted. Requires syncTemplateId.

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

      the request property became optional

    • info

      the request property became optional

    • 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