amb-suppressions

Create an Apple Messages for Business suppression

Manually opens a suppression episode for a address, blocking every outbound path to it: operator and automated replies, API sends, typing indicators, and invitations. Set business_account_id to block the address for one brand only, or omit it to block the address for every brand in the workspace. If the address already has an active episode with reason manual, the API returns 200 with the existing episode instead of creating a second one.

post/v1/amb/suppressions

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/amb/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

business_account_idstring
addressstring required

The phone number or opaque identifier to suppress. For a phone number, supply canonical E.164 with a leading plus sign.

address_type'phone_number' | 'opaque_user_id' required

What kind of value address holds.

  • phone_number means address is the customer's phone number. Apple's CloseSession event carries a phone number rather than an opaque identifier, so a suppression opened by a close on a conversation identified by phone number takes this kind.
  • opaque_user_id means address is the opaque identifier Apple assigns to the customer's conversation with the business, stable across a close and a later re-initiation.

Example request

{
  "business_account_id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
  "address": "+15551234567",
  "address_type": "opaque_user_id"
}

Response

Handle was already suppressed for this reason. Existing episode returned.

idstring required
business_account_idstring required
addressstring required

Canonical E.164 phone number, or the exact opaque identifier Apple supplied.

address_type'phone_number' | 'opaque_user_id' required

What kind of value address holds.

  • phone_number means address is the customer's phone number. Apple's CloseSession event carries a phone number rather than an opaque identifier, so a suppression opened by a close on a conversation identified by phone number takes this kind.
  • opaque_user_id means address is the opaque identifier Apple assigns to the customer's conversation with the business, stable across a close and a later re-initiation.
reasonstring required

Why the handle is suppressed. manual means it was added directly through this API or the dashboard. opted_out covers every case where Apple or the customer signaled they should not be contacted: a close, a permanent delivery failure, a declined invitation, or a stop keyword. This list grows over time, so treat an unknown value as informational rather than rejecting the record.

originstring required

Who created the episode. user and api_key identify manual blocks. close_session and gone are protected automatic conversation facts. Phone invitation opt-outs are recorded as preferences.

applies_tostring required

Paths blocked by this episode. Treat unknown values as blocking.

source_message_idstring
source_event_idstring
source_end_message_idstring
effective_atstring date-time required

When the blocking state took effect.

created_atstring date-time required

When Bird recorded this episode.

ended_atstring date-time nullable required

When Bird recorded the end, or null while active.

ended_reasonstring nullable required

What ended the episode, or null while active. Customers can end only manual episodes.

ended_effective_atstring date-time nullable required

When the end took effect, or null while active.

Example response

{
  "id": "asp_01krdgeqcxet5s7t44vh8rt9mg",
  "business_account_id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
  "address": "+15551234567",
  "address_type": "opaque_user_id",
  "reason": "manual",
  "origin": "user",
  "source_message_id": "amb_01krdgeqcxet5s7t44vh8rt9mg",
  "source_event_id": "aev_01krdgeqcxet5s7t44vh8rt9mg",
  "source_end_message_id": "amb_01krdgeqcxet5s7t44vh8rt9mg"
}

Changes

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