POST
/api/v1/server/cad/unit-groups/{groupId}/status
Request
Response
200
Success
Authorization
AuthorizationstringrequiredYour API token as
Bearer YOUR_TOKEN. Create one in your server's dashboard settings.Path parameters
groupIdstringrequiredBody
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
idintegerrequiredUnit group ID.
namestringrequiredDisplay name.
panicbooleanrequiredWhether panic is active.
premadebooleanrequiredWhether it's a premade group.
serverIdstringrequiredServer ID.
statusintegerrequiredStatus code.
unitsobjectrequiredUnits attached.
customStatusIdstring | nullCustom status, when one is set.
maxUnitsinteger | nullMost units that can join.
restrictAgencystring | nullOnly this agency's units can join.
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 custom status isn't on the group's 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 |