POST
/api/v1/server/cad/calls
Request
Response
201
Created
Units you list are assigned straight away if they're signed in to a service panel, and are moved off any call they're already on. The call starts open when units are assigned, and pending otherwise.
Authorization
AuthorizationstringrequiredYour API token as
Bearer YOUR_TOKEN. Create one in your server's dashboard settings.Body
createdBystringrequiredMember ID of the dispatcher creating the call. Needs the Dispatch Panel permission.
titlestringrequired1-45 characters.
addressstring | nullUp to 45 characters.
codestring | nullCall code, such as
10-80. Up to 45 characters.descriptionstringUp to 4000 characters.
originstring | nullWhere the call came from, such as
911. Up to 45 characters.postalstring | nullUp to 45 characters.
primaryUnitobject | nullA CAD unit, or a group of units working together.
prioritystring | nullUp to 45 characters.
unitsobject[]Units to assign straight away. Only units signed in to a service panel are assigned, and they're moved off any call they're already on.
Response
201 Created
createdAtintegerrequiredWhen it was created.
createdByUserIdstringrequiredMelonly user ID of who created the call.
descriptionstringrequiredLonger description.
idstringrequiredUnique ID.
panelsobjectrequiredPanels the call is shown on.
recordsobjectrequiredRecords attached.
serverIdstringrequiredServer ID.
statusintegerrequiredStatus code.
titlestringrequiredTitle.
typeintegerrequiredType code.
unitHistoryobjectrequiredUnits that have been on the call.
unitsobjectrequiredUnits attached.
addressstring | nullAddress.
apiIdstring | nullID set by an integration that created the call.
closedAtinteger | nullWhen the call was closed.
codestring | nullCall code.
createdByUnitobject | nullUnit that created the call.
locobject | nullMap position.
originstring | nullWhere the call came from.
postalstring | nullPostal code.
primaryUnitobject | nullUnit leading the call.
prioritystring | nullCall priority.
Errors
| Status | Meaning |
|---|---|
400 | Invalid request. validation_failed lists each invalid field in details.fields. |
401 | Missing, invalid or expired token |
403 | createdBy can't dispatch in this CAD |
404 | CAD is not set up |
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 |