whatsapp-suppressions

Get a WhatsApp suppression

Returns the suppression record for the given ID, including one that has already ended. An ended record keeps its dates and reports when and how it ended.

get/v1/whatsapp/suppressions/{suppression_id}

Request

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

Headers

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.

Response

The suppression record for the requested ID.

idstring required
addressstring required

The suppressed WhatsApp address. For a phone number this is canonical E.164 with a leading plus sign, such as +5511977670804.

wabastring nullable

The WhatsApp Business Account the suppression is limited to, identified by its WhatsApp-issued account ID, or null when it covers the whole workspace.

reasonstring required

Why the address is suppressed. manual means it was added directly rather than created automatically from a delivery outcome. This list grows over time, so treat an unknown value as informational rather than rejecting the record.

originstring required

How the suppression came to exist: api_key (added through the API with an API key) or user (added by a user in the dashboard). This list grows over time, so treat an unknown value as informational rather than rejecting the record.

applies_tostring required

Blocking policy. all blocks every message category. Treat an unrecognized value as blocking.

source_whatsapp_idstring
ended_atstring date-time nullable

When this stopped applying. Null while it is still stopping messages, which is the case for every record in the list.

ended_reasonstring nullable

What ended it: api_key (deleted through the API with an API key) or user (deleted by a user in the dashboard). Null while it is still stopping messages. This list grows over time, so treat an unknown value as informational rather than rejecting the record.

created_atstring date-time required

When the suppression was created.

Example response

{
  "id": "was_01krdgeqcxet5s7t44vh8rt9mg",
  "address": "+5511977670804",
  "source_whatsapp_id": "wam_01krdgeqcxet5s7t44vh8rt9mg"
}

Changes

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