Update Apple Messages for Business channel settings
PATCH
/v1/amb/businesses/{business_id}/channel-settings
const result = await bird.amb.businesses.settings.update(
"abz_01krdgeqcxet5s7t44vh8rt9mg",
{ brand_name: "Acme Support", logo_asset_id: null },
);
console.log(result);result = client.amb.businesses.settings.update('abz_01krdgeqcxet5s7t44vh8rt9mg', brand_name='Acme Support', logo_asset_id=None)
print(result)result, err := client.Amb.Businesses.Settings.Update(ctx, "abz_01krdgeqcxet5s7t44vh8rt9mg", bird.AmbBusinessesSettingsUpdateParams{BrandName: bird.Ptr("Acme Support"), LogoAssetID: bird.Null[string]()})
if err != nil {
log.Fatal(err)
}
fmt.Println(result)$bird->amb->businesses->settings->update('abz_01krdgeqcxet5s7t44vh8rt9mg', (new Model\AMBChannelSettingsUpdate())->setBrandName('Acme Support')->setLogoAssetId(null));bird amb businesses settings update <business-id> --body-file - <<'JSON'
{
"brand_name": "Acme Retail",
"default_locale": "en-US",
"entry_points": [
{
"id": "website-footer",
"group": "support",
"intent": "general-inquiry",
"body": "Hi, I have a question about my order."
}
]
}
JSONcurl -X PATCH "https://us1.platform.bird.com/v1/amb/businesses/{business_id}/channel-settings" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"brand_name": "Acme Retail",
"default_locale": "en-US",
"entry_points": [
{
"id": "website-footer",
"group": "support",
"intent": "general-inquiry",
"body": "Hi, I have a question about my order."
}
]
}'Risposta200
{
"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.
Parametri
business_id
string
ID of the Apple Messages for Business record, as returned by the business list.
Payload della richiesta
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.
Mostra parametri secondari
entry_points.id
string
obbligatorio
Identifier for this entry point, chosen by you and unique within the business's entry points. A conversation opened through this entry point carries it as entry_point.
entry_points.group
string
obbligatorio
The group value Apple reports on a conversation opened through this entry point. Matched against the group the first inbound message carries.
entry_points.intent
string
obbligatorio
The intent value Apple reports on a conversation opened through this entry point. Matched against the intent the first inbound message carries, together with group.
entry_points.body
string
obbligatorio
The message text pre-filled for the customer when they open a conversation through this entry point.
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.
Payload di risposta
entry_points
array of object
obbligatorio
The entry points customers can use to open a conversation with this business, each matched against the group and intent an inbound message reports.
Mostra attributi secondari
entry_points.id
string
obbligatorio
Identifier for this entry point, chosen by you and unique within the business's entry points. A conversation opened through this entry point carries it as entry_point.
entry_points.group
string
obbligatorio
The group value Apple reports on a conversation opened through this entry point. Matched against the group the first inbound message carries.
entry_points.intent
string
obbligatorio
The intent value Apple reports on a conversation opened through this entry point. Matched against the intent the first inbound message carries, together with group.
entry_points.body
string
obbligatorio
The message text pre-filled for the customer when they open a conversation through this entry point.
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
obbligatorio
The brand name shown on the Bird-hosted landing page customers use to connect this business.
logo_asset_id
nullable string
obbligatorio
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.
Risorse correlate
Prosegui con la documentazione, le guide e gli esempi per questo argomento. Le risorse sono in inglese.
Comprendi il concettoShould I use a Bird SDK or call the API directly?Segui il percorso di apprendimentoBuild your first integrationGuida all'implementazioneSend your first email
Ottieni un brief di implementazione