SendStreak logo
menu

Pause an announcement

Stops a running announcement from sending any further batches. Delivery halts at the next batch boundary, not instantly: a batch already in flight finishes its recipients, because a message handed to the mail server cannot be recalled. The announcement keeps its progress and can be resumed. Only a running announcement can be paused; anything else is a 409 naming the state it is in.

Endpoint

POST https://api.sendstreak.com/v2/accounts/{accountId}/announcements/{announcementId}/pause

All v2 endpoints require a bearer token - see Authentication.

Path parameters

Parameter Type Description
accountId string The account the request is scoped to.
announcementId string  

Response

The announcement, now paused.

{
  "_id": "665f0a2b1c9d440012ab34cd",
  "name": "Example name",
  "templateId": "6650cc1d3e8a220013ef78ab",
  "subject": "Welcome to Acme!",
  "topicId": "6651dd2e4f9b110014ab90cd",
  "includeUnsubscribed": false,
  "attributes": [
    {
      "slug": "plan",
      "operator": "s_equal",
      "value": "professional"
    }
  ],
  "status": "running",
  "statusDetails": "Template not found",
  "processDate": "2026-07-07T09:30:00.000Z",
  "lastSampledContactId": "665f0a2b1c9d440012ab34cd",
  "createDate": "2026-07-07T09:30:00.000Z"
}

Errors

Status Description
401 Missing or invalid token, or the token is not authorized for this account/user.
404 The requested resource does not exist.
409 The resource is not in a state that allows this action. The message names the state it is in.

See Errors and rate limits for what error responses look like.

Curl example

curl --location --request POST 'https://api.sendstreak.com/v2/accounts/YOUR_ACCOUNT_ID/announcements/YOUR_ANNOUNCEMENT_ID/pause' \
--header 'Authorization: Bearer YOUR_API_TOKEN'
Try SendStreak for Free now!