POST
/api/v1/server/cad/units/{unitId}/status
Request
Response
200
Success
Authorization
AuthorizationstringrequiredYour API token as
Bearer YOUR_TOKEN. Create one in your server's dashboard settings.Path parameters
unitIdstringrequiredBody
performedBystringrequiredMember ID of the dispatcher. Needs the Dispatch Panel permission.
statusstringrequiredAllowed values:
availableunavailablebusyenrouteonScenecustomcustomStatusIdstring | nullThe custom status to use when
status is custom.Response
200 Success
agencystringrequiredAgency.
idintegerrequiredUnit ID.
itemsobjectrequiredEquipment carried.
locobjectrequiredMap position.
numberstringrequiredUnit number, such as
1A-12.panicbooleanrequiredWhether panic is active.
serverIdstringrequiredServer ID.
statusintegerrequiredStatus code.
userIdstringrequiredMelonly user ID of who's on the unit.
customStatusIdstring | nullCustom status, when one is set.
locationstring | nullLocation text.
namestring | nullCallsign name.
rankstring | nullRank.
subdivisionstring | nullSubdivision.
Errors
| Status | Meaning |
|---|---|
400 | Invalid request. validation_failed lists each invalid field in details.fields. |
401 | Missing, invalid or expired token |
403 | Success |
404 | Not found |
409 | The unit isn't signed in, or the custom status isn't on its panel |
429 | Rate limited. See Retry-After and details. |
500 | Internal server error |
502 | next did not confirm the write. Check whether it applied before retrying. |
503 | Write endpoints are not configured on this deployment |