try out ↗

← API Index


/api/admin/message/series/cancel

Remove the not-yet-sent messages of a message series from the queue (a series queued via message/series, pushactiongroup, or by PCG). Admin only, idempotent. Messages already handed to a provider are not affected; the series statistics keep what was sent.

Parameters

Name Description Type
serieref the series reference int
oo-rf optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml String
oo-auth optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized. int

Error Responses

HTTP Status Error Code Description
401 not_authorized Caller is not an admin
400 parameter_error serieref missing or unknown

Response Types

Type Version Description
MessageSeriesResult 1 Result of queueing or cancelling a message series

OpenAPI

See cancel.yaml

Referenced in skills