APIСправочникBroadcasts
Cancel a broadcast
Stops it; items not sent yet are cancelled.
An administrator may do this to any broadcast; anyone else only when the items it touches go
out from numbers they work in (403 forbidden otherwise).
Authorization
personalToken AuthorizationBearer <token>
Your personal access token from Profile → Access Token in Lalexi. It acts with exactly your role: what you may see and do in the workspace, and nothing more. Everything done with it is recorded as done by you.
In: header
Path Parameters
id*integer
The broadcast's id.
Header Parameters
X-Workspace-Id?integer
The workspace to work in (an id from GET /me). Optional when you belong to a single
workspace; required otherwise (400 workspace_required).
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://app.lalexi.com/v1/broadcasts/0/cancel" \ -H "X-Workspace-Id: 7"{
"id": 0,
"name": "string",
"status": "draft",
"items_total": 0,
"items_by_status": {
"property1": 0,
"property2": 0
},
"created_at": "2019-08-24T14:15:22Z",
"scheduled_at": "2019-08-24T14:15:22Z",
"completed_at": "2019-08-24T14:15:22Z"
}{
"error": {
"code": "workspace_required",
"message": "You belong to several workspaces: pass the X-Workspace-Id header."
}
}{
"error": {
"code": "invalid_api_key",
"message": "The API key is missing or invalid."
}
}{
"error": {
"code": "forbidden",
"message": "You are not allowed to do this."
}
}{
"error": {
"code": "not_found",
"message": "Resource not found."
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. Retry after the number of seconds in Retry-After."
}
}{
"error": {
"code": "internal_error",
"message": "Something went wrong on our side."
}
}{
"error": {
"code": "upstream_unavailable",
"message": "The messaging service is unavailable. Nothing was sent; try again."
}
}