Acknowledge a synchronization

post

https://example.com/v1/changes/acknowledge

Use this when recording the result of a connection synchronization.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

interface

string

required

Graphite supports acknowledgment date tracking for multiple interfaces. Include the name of your interface here. This name should match the interface name used in the changes/connections API call.

connectionRole

string

enum

Connection role belonging to the calling entity. Required to specify a connection when more than one connection exists between the same two entities.

Allowed:

publicIds

array of strings

required

deprecated

The acknowledge API only supports acknowledging one connection at a time. Use publicId or connectionId.

publicIds*

publicId

string

required

The public id of the connected entity to acknowledge. Use this or connectionId to identify the connection.

instanceIds

array of strings

required

deprecated

The acknowledge API only supports acknowledging one instance at a time. Use instanceId.

instanceIds*

instanceId

string

required

The _id value of the ERP_Record or groupKey instance corresponding to this acknowledgement.

instanceAnswerKey

string

Alternative to instanceId. Together with instanceAnswerValue and groupKey, resolves the instance within the group whose answer for this key equals instanceAnswerValue. Deleted/hidden instances are ignored. If multiple non-deleted instances match, the request is rejected.

instanceAnswerValue

string

Value paired with instanceAnswerKey to resolve the target instance.

groupKey

string

required

The default behavior of Acknowledge is to update the status in an instance of an ERP_Record group, identified by instanceId. The groupKey field overrides this behavior and will allow acknowledgments to update the status in any group.

connectionId

string

required

The id of the connection to acknowledge. Use this or publicId to identify the connection.

errors

array of strings

required

If there were any errors encountered when synchronizing a connection, you can report them by including this property. If this property is included and not empty, the acknowledgment is deemed unsuccessful.The corresponding connection will remain on the changes list and the 'Last Integration Date' will not be updated.

errors*

upTo

date-time

The default behavior of Acknowledge is to update a sync date equal to the last updated at date.
This field allows the caller to set a custom sync-date, preventing overwriting changes that occured during an integration.

applyToAllInstances

boolean

When true and no instanceId (or instanceAnswerKey/instanceAnswerValue) is provided, the acknowledgment is applied to every existing instance of groupKey (e.g. all ERP_Record instances). Use this to surface a connection-level integration error onto all records when no specific instance is known.

Response

201