HIhightouch

Get Sync Draft

Changed on

Retrieve a sync draft with the sync as it is now and as approval would leave it. Send its draftVersion and resourceVersion to approve it.

get/syncs/{syncId}/drafts/{draftId}

Request

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

Path parameters

syncIdnumber double required

The id of the sync

draftIdstring required

The id of the draft

Response

Ok

idstring required

The draft's id

syncIdstring required

The id of the sync the draft changes

operation'create' | 'update' required

create publishes a new sync, update changes an existing one

status'pending' | 'approved' | 'rejected' | 'canceled' required

The state of a sync draft. New values may be added, so treat an unknown value as closed.

requestCommentstring nullable required

The comment the requester left for reviewers

createdAtstring date-time required

The timestamp when the draft was created

updatedAtstring date-time required

The timestamp when the draft last changed

reviewedAtstring date-time nullable required

The timestamp when the draft was approved or rejected

changedFieldsstring[] required

The top-level sync fields that the draft changes

draftVersionstring required

Send as expectedDraftVersion to approve exactly this version of the draft

resourceVersionstring required

Send as expectedResourceVersion to approve only if the sync has not changed

Changes