amb-business-accounts

Update Apple Messages for Business channel settings

Changes the channel settings for your workspace's Apple Messages for Business record. Fields you omit are left as they are, except entry_points: sending it replaces the entire set, since there is no way to add or remove a single entry point without resending the rest.

patch/v1/amb/business-accounts/{business_account_id}/channel-settings

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/amb/business-accounts/{business_account_id}/channel-settings
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Path parameters

business_account_idstring required
Example:abz_01krdgeqcxet5s7t44vh8rt9mg

ID of the Apple Messages for Business record, as returned by the business list.

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

default_localestring nullable

The locale used for this business when a conversation reports none of its own, in BCP-47 form. Omit this field to keep the current default, or send null to clear it. Bird converts a configured default to Apple's locale form when sending a message without a conversation locale.

brand_namestring

The brand name shown on the Bird-hosted landing page customers use to connect this business.

logo_asset_idstring

Example request

{
  "entry_points": [
    {
      "id": "website-footer",
      "group": "support",
      "intent": "general-inquiry",
      "body": "Hi, I have a question about my order."
    }
  ],
  "default_locale": "en-US",
  "brand_name": "Acme Retail",
  "logo_asset_id": "ast_01krdgeqcxet5s7t44vh8rt9mg"
}

Response

The updated channel settings.

default_localestring nullable

The locale used for this business when a conversation reports none of its own, in canonical BCP-47 form. Null until you set one or after you clear it. Bird converts a configured default to Apple's locale form when sending a message without a conversation locale.

brand_namestring required

The brand name shown on the Bird-hosted landing page customers use to connect this business.

logo_asset_idstring required

Example response

{
  "entry_points": [
    {
      "id": "website-footer",
      "group": "support",
      "intent": "general-inquiry",
      "body": "Hi, I have a question about my order."
    }
  ],
  "default_locale": "en-US",
  "brand_name": "Acme Retail",
  "logo_asset_id": "ast_01krdgeqcxet5s7t44vh8rt9mg"
}

Changes

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