Sign inGet Started

Update Apple Messages for Business channel settings

PATCH
/v1/amb/business-accounts/{business_account_id}/channel-settings
const result = await bird.amb.businessAccounts.settings.update(
  "abz_01krdgeqcxet5s7t44vh8rt9mg",
  { brand_name: "Acme Support", logo_asset_id: null },
);
console.log(result);
Réponse200
{
  "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 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.

Paramètres

business_account_idstring

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

Corps de la requête

entry_points
array of object

The entry points customers can use to open a conversation with this business. Sending this replaces the entire set; there is no way to add or remove a single entry point without resending the rest.

Afficher les paramètres enfants
default_locale
nullable string

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_name
string

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

logo_asset_id
nullable string

The business's logo, as an asset in your media library. Send null to clear it.

Contenu de la réponse

entry_points
array of object
obligatoire

The entry points customers can use to open a conversation with this business, each matched against the group and intent an inbound message reports.

Afficher les attributs enfants
default_locale
nullable string

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_name
string
obligatoire

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

logo_asset_id
nullable string
obligatoire

The business's logo, as an asset in your media library. Null until one is set, either from Apple's own redirect or from a later change here.

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.