Sign in

v1

latestOpenAPI 3.0.02026-07-2412592575.3 KB
sync

Sync an existing connection

Requires accounts:read and either accounts:write or accounts:write:all scopes.

post/sync/{connectionId}

Path parameters

connectionIdstring required

The connection id

Request body

customerIpAddressstring

The customer ip address if it is currently logged in

customerLastLoggedTimestring

The time when the customer last logged in represented as an ISO 8601 date-time format including timezone

enableAsyncboolean

If set to true, the sync for data will happen in the background

Example request

{
  "customerIpAddress": "104.25.212.99",
  "customerLastLoggedTime": "2017-04-05T10:43:07.000Z"
}

Response

Successful Sync Response

metaobject

Example response

{
  "data": {
    "syncId": "9f3678b2-9fd1-47dd-8b69-4eab49bd2d66",
    "status": "ok"
  }
}