Create Sync Template
Create a new sync template
A sync template holds a destination configuration that syncs created from
it share. overrideConfig names the configuration fields those syncs may
set for themselves; every other field is locked to the template’s value.
Create a sync from the template with POST /syncs and syncTemplateId.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
The input for creating a Sync Template. A slug is generated automatically
from the name; it is a legacy column and is no longer accepted on input.
Response
Ok
A sync template defines a reusable sync configuration that can be shared across multiple syncs. User Groups can be granted access to templates so users can create syncs from them without seeing the raw destination credentials.
The sync template's id
The sync template's name
The id of the workspace that the sync template belongs to
The timestamp when the sync template was created
The timestamp when the sync template was last updated
The id of the parent Model that the sync template is connected to
The id of the Destination that the sync template is connected to. Cannot be changed after creation.
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.
The sync template's schedule. May be null if the template does not impose a schedule on its child syncs.
Whether the sync template's schedule is paused
The tags of the sync template
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.
The sync template's description
Match Booster region for syncs created from this template. Null means inherit the model's single-region default at runtime.