Skip to content

Queue a full sync of one register configuration

POST
/v1/integrations/{provider}/connections/{connection_id}/instances/{instance_id}/sync
curl --request POST \
--url https://api.adversarial.com/api/v1/integrations/example/connections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/instances/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/sync
provider
required
string

Provider slug

connection_id
required
string format: uuid

Connection identifier

instance_id
required
string format: uuid

Configuration identifier

Sync queued

Media typeapplication/json

Acknowledgement that an import has been accepted for background processing (HTTP 202).

object
status
required

Dispatch status; "queued" when the import has been accepted.

string

Example generated

{
"status": "example"
}

Configuration has no register capability

Missing the write permission of the configuration’s register

Unknown provider, connection, or configuration