Skip to content

GET /api/admin/suspend/v1

Note

This page was generated by extracting information from a JSON Schema data file for the API. It may be missing some information, or otherwise suggest approximate or placeholder values based on information in the schema file; this is due to limitations on how that data is extracted from the underlying Rust code and into the JSON Schema, and then again from there and into these docs.

List the active scheduled-queue suspensions

Responses

Status 200

Suspended

Content-Type: application/json

This is an object value, with the following properties:

  • campaign - optional nullable string. The campaign name to match. If omitted, any campaign will match.

  • domain - optional nullable string. The domain name to match. If omitted, any domain will match.

  • duration - required string. Specifies how long this suspension remains active.

  • id - required string (uuid). The id of the suspension. This can be used later to cancel the suspension.

  • reason - required string. The reason for the suspension

  • tenant - optional nullable string. The tenant name to match. If omitted, any tenant will match.

Examples

{
  "campaign": "campaign_name",
  "domain": "example.com",
  "duration": "string",
  "id": "9511a32e-66f8-42aa-b151-ccb176df47d9",
  "reason": "pause while working on resolving a deliverability issue",
  "tenant": "tenant_name"
}