sms-suppressions

Create an SMS suppression

Stops a sender's messages to a subscriber, with reason manual, blocking every category including transactional. Both ends are required: a suppression covers a sender-and-subscriber pair, so stopping all of your senders means one call per sender.

Adding is idempotent. A 201 means a new suppression was recorded, and a 200 means a manual one for that pair was already in place and is returned unchanged. A pair already stopped for another reason, such as the subscriber having texted a stop keyword, still gets its own manual record, and messages stay stopped until every one of them has ended.

post/v1/sms/suppressions

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/sms/suppressions
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Headers

Idempotency-Keystring

Client-supplied key. On operations supporting request deduplication, a retained response is replayed for duplicate requests with the same key within the idempotency window (3 hours by default). This protection requires a workspace, organization, or staff-account scope. User-only and unscoped unauthenticated operations, streams, and operations with a separate replay contract do not use this response replay.

On a supported operation, if idempotency protection is unavailable before execution, the API returns 503 IdempotencyUnavailable (E01033) without executing this attempt. Retry with backoff using the same key and request. An operation that takes effect before its response is retained can still execute again on retry.

Two distinct 409 errors signal misuse:

  • request_in_progress (E01004): The same key is currently being processed by a concurrent request. Wait briefly and retry. The lock expires within 30 seconds.
  • idempotency_key_reuse (E01005): The same key has already completed against a different request body or method. Generate a new key.

Recommended key format is <event-type>/<entity-id> (for example welcome-user/usr_abc123).

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Request body

destinationstring required

The subscriber to stop messaging, in E.164 format.

originatorstring required

The sender to stop. Your other senders keep reaching this subscriber, so stopping every one of them means one call per sender.

Example request

{
  "destination": "+15550001234",
  "originator": "+15557654321"
}

Response

A manual suppression for this pair was already in place. The existing one is returned.

idstring required
destinationstring required

The subscriber, in E.164 format.

originatorstring required

The sender this stops. A suppression covers one sender, so your other senders still reach this subscriber. Opting out of one of your programs does not opt out of the others.

reasonstring required

Reason this sender cannot message the subscriber:

  • keyword_stop: The subscriber sent a stop keyword. A start keyword clears it.
  • carrier_opted_out: The carrier reported the opt-out.
  • manual: Your workspace added the suppression through the API or dashboard.

This is an open enum. Accept unrecognized values.

originstring required

How the opt-out reached us:

  • keyword: an inbound message from the subscriber.
  • dlr_event: a carrier delivery report.
  • api_key: an API call.
  • user: someone acting in the dashboard.

Kept beside the reason because one reason can arrive by more than one route.

This list grows over time, so treat an unknown value as informational rather than rejecting the record.

applies_tostring required

Message categories blocked for this sender and subscriber. all blocks every category, including authentication and transactional messages. non_transactional blocks marketing messages only. Responses currently use all. Treat unrecognized values as blocking every category.

blockingboolean required

Whether this is stopping messages right now. Always true in a list, which carries only the suppressions in force; false when you fetch one by ID that has since ended, which is also when ended_at is set.

source_sms_idstring
effective_atstring date-time required

When the subscriber opted out, as reported by whoever reported it. This is what orders one subscriber's history, and it can be earlier than created_at when a message reached us late.

ended_atstring date-time nullable

When this stopped applying. Null while it is still stopping messages.

ended_reasonstring

What ended it:

  • keyword_start: the subscriber texting a start keyword to the same sender.
  • api_key: an API call.
  • user: someone acting in the dashboard.
  • carrier_cleared: the carrier reporting its own opt-out cleared.

This list grows over time, so treat an unknown value as informational rather than rejecting the record.

ended_effective_atstring date-time nullable

When the subscriber opted back in, as reported. Null while it is still stopping messages.

source_end_sms_idstring
created_atstring date-time required

When we recorded it.

last_asserted_atstring date-time required

When we last recorded the subscriber opting out of this sender. Later than created_at when they texted a stop keyword again while already suppressed, which adds no new record but does earn another confirmation reply.

Example response

{
  "id": "ssu_01krdgeqcxet5s7t44vh8rt9mg",
  "destination": "+15550001234",
  "originator": "+15557654321",
  "source_sms_id": "sms_01krdgeqcxet5s7t44vh8rt9mg",
  "source_end_sms_id": "sms_01krdgeqcxet5s7t44vh8rt9mg"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.