Skip to content
Docs
Select language:English

/api/v1/sync/ops

POST
/api/v1/sync/ops
curl --request POST \
  --url https://example.com/api/v1/sync/ops \
  --header 'Content-Type: application/json' \
  --data '{ "clientVersion": "example", "ops": [ { "clientVersion": "example", "payloadVersion": 1, "clientId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "idempotencyKey": "example", "op": "create_thing", "takenAt": "2026-04-15T12:00:00Z", "locationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "dependsOn": [ "example" ], "payload": "example" } ] }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
clientVersion
required
string
>= 1 characters <= 40 characters
ops
required
Array<object>
>= 1 items <= 50 items
object
clientVersion
required
string
>= 1 characters <= 40 characters
payloadVersion
required
integer
<= 1000
clientId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
idempotencyKey
required
string
>= 1 characters <= 200 characters
op
required
string
Allowed values: create_thing move log_reading claim_label mark_seen not_here create_area box_check move_box
takenAt
required
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
locationId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
dependsOn
Array<string>
<= 50 items
payload
required

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
results
required
Array<object>
object
clientId
required
string
idempotencyKey
required
string
outcome
required
string
Allowed values: applied needs_review dropped
reason
string
entity
object
type
required
string
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
shortCode
string | null
notice
object
name
required
string
by
required
object
displayName
required
string
action
required
string
Allowed values: trashed moved removed
inboxItemId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
Example
{
  "results": [
    {
      "outcome": "applied",
      "notice": {
        "action": "trashed"
      }
    }
  ]
}