HIhightouch

Update Sync Template

Changed on

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.

patch/sync-templates/{syncTemplateId}

Request

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

Path parameters

syncTemplateIdnumber double required

The sync template's ID

Request body

namestring

The sync template's name

configurationobject

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.

descriptionstring nullable

The sync template's description

modelIdnumber double

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

scheduleobject nullable

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

schedulePausedboolean

Whether the sync template's schedule is paused

tagsobject

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

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

OR
OR
'Internal Server Error' required

Changes