HIhightouch

Get Sync Template

Changed on

Retrieve a sync template given its ID

get/sync-templates/{syncTemplateId}

Request

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

Path parameters

syncTemplateIdnumber double required

The id of the sync template

Response

Ok

idnumber double required

The sync template's id

namestring required

The sync template's name

descriptionstring nullable

The sync template's description

workspaceIdnumber double required

The id of the workspace that the sync template belongs to

createdAtstring date-time required

The timestamp when the sync template was created

updatedAtstring date-time required

The timestamp when the sync template was last updated

modelIdnumber double required

The id of the parent Model that the sync template is connected to

destinationIdnumber double required

The id of the Destination that the sync template is connected to. Cannot be changed after creation.

configurationobject required

The sync template's configuration. The schema depends on the destination type.

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

scheduleobject nullable required

The sync template's schedule. May be null if the template does not impose a schedule on its child syncs.

schedulePausedboolean required

Whether the sync template's schedule is paused

tagsobject required

The tags of the sync template

matchboosterRegionstring nullable

Match Booster region for syncs created from this template. Null means inherit the model's single-region default at runtime.

overrideConfigobject nullable required

Which configuration fields syncs created from this template may override, keyed by configuration field path (for example "externalIdMapping" or "target.schema"). A field is unlocked when listed with overridable: true; every other field is locked to the template's value. Null when no field is overridable.

Changes