Update Sync Template
Update an existing sync template
Patch a sync template based on its Hightouch ID. The destinationId of a
sync template cannot be changed after creation. Syncs created from the
template pick up a new configuration on their next run; a new
overrideConfig replaces the previous one and applies to the next write
of each sync’s syncTemplateOverrides.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The sync template's ID
Body
The input for updating a Sync Template. destinationId cannot be changed
after creation.
The sync template's name
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 description
The id of the parent Model that the sync template is connected to
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
Match Booster region for syncs created from this template. Null means inherit the model's single-region default at runtime.
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.
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.