Skip to content

Update Object Sync Binding

PATCH
/integrations/object-sync/bindings/{binding_id}

Change mappings, the match key, the deletion policy or the switch. resume clears a pause.

Authorizations

Parameters

Path Parameters

binding_id
required

The binding id (UUID).

string format: uuid

The binding id (UUID).

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Change a binding’s mappings, match key, deletion policy or switch. resume clears a pause.

object
acknowledged_deletions
Any of:
integer
connection_id
required
string
>= 1 characters <= 255 characters
delete_policy
Any of:
string
Allowed values: ignore archive
enabled
Any of:
boolean
fields
Any of:
Array<object>
>= 1 items <= 200 items

One mapped field. authority decides a conflict: CRM wins, graph8 wins or the newest change wins.

object
attribute_id
required
string format: uuid
authority
Any of:
string
Allowed values: crm graph8 newest
crm_field
required
string
>= 1 characters <= 255 characters
restricted_acknowledged
boolean
match
Any of:

The explicit match key: a CRM field and a unique graph8 field.

object
attribute_id
required
string format: uuid
crm_field
required
string
>= 1 characters <= 255 characters
relationships
Any of:
Array<object>
<= 20 items

A CRM reference (Salesforce lookup field, HubSpot association) to a graph8 relationship definition.

authority (default crm): crm = a pull moves the link when the CRM lookup names another record and removes it when the lookup is cleared; graph8 = a pull only adds links (a taken single-valued link is a link_conflict). A push only ever adds references, whatever the authority.

object
authority
Any of:
string
Allowed values: crm graph8
crm_field
Any of:
string
<= 255 characters
relationship_definition_id
required
string format: uuid
target_crm_object_id
required
string
>= 1 characters <= 255 characters
resume
boolean

Responses

200

Successful Response

object
data
required

An object-sync answer: capability, setup defaults, a binding, a run, a conflict list or a resolution.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string