amb-business-accounts

Get Apple Messages for Business channel settings

Returns the channel settings for your workspace's Apple Messages for Business record: its entry points, default locale, and the brand name and logo shown on the landing page customers use to connect it.

get/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

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 business's 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.