Operation
Dispatch a command
POST
/devices/{deviceId}/commandsQueue a command for a device or one of its peripherals. Idempotent on Idempotency-Key.
Path parameters
deviceIdstringRequired
Headers
Idempotency-KeystringOptional- Makes the write safe to retry. The first request with a key does the work and its response is stored for 24 hours; a repeat with the same key and the same request (method, path, query, X-Ticketlayer-Channel, TL-Version and body) gets that stored status and body back, marked `Idempotent-Replay: true`, without running again. The key is scoped to your organisation and your credential. The same key with a different request is 422 IDEMPOTENCY_KEY_REUSED; a repeat while the first is still running waits for it, then answers 409 IDEMPOTENT_REQUEST_IN_PROGRESS if it has not finished. Only a 2xx is stored: after an error the key is free again. Omit the header and the request behaves as it always has.
Body
type*string
payloadobject
peripheralIdstring
idempotencyKeystring
Returns
Command dispatched
Errors
- 400
- Bad Request - Invalid input
- 401
- Unauthorized - Authentication required
- 403
- Forbidden - Insufficient permissions
- 404
- Not Found - Resource not found
- 500
- Internal Server Error
Every error names its code and links to it. All error codes
curl -X POST "https://api.ticketlayer.com/v1/devices/{deviceId}/commands" \ -H "Authorization: Bearer tlak_..." \ -H "X-Ticketlayer-Org: your-org-slug" \ -H "Content-Type: application/json" \ -d '{ "type": "string", "payload": {}, "peripheralId": "string", "idempotencyKey": "string" }'Response 201
{
"command": {
"id": "string",
"deviceId": "string",
"peripheralId": "string",
"type": "string",
"status": "string",
"payload": {},
"idempotencyKey": "string",
"progress": {},
"result": {},
"createdBy": {
"type": "string",
"id": "string"
},
"expiresAt": "string",
"createdAt": "string",
"deliveredAt": "string",
"completedAt": "string"
}
}