---
title: "Update Apple Messages for Business channel settings"
method: PATCH
path: "/v1/amb/business-accounts/{business_account_id}/channel-settings"
tags: ["amb-business-accounts"]
---

# Update Apple Messages for Business channel settings

`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`

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.

## Path parameters

- `business_account_id` string, required

## Headers

- `Idempotency-Key` string
- `X-Workspace-Id` string
- `X-Organization-Id` string

## Request body

- AMBChannelSettingsUpdate
  - `entry_points` AMBEntryPoint[]: 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.
    - `id` string, required: 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`.
    - `group` string, required: The group value Apple reports on a conversation opened through this entry point. Matched against the `group` the first inbound message carries.
    - `intent` string, required: 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`.
    - `body` string, required: The message text pre-filled for the customer when they open a conversation through this entry point.
  - `default_locale` string, 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_name` string: The brand name shown on the Bird-hosted landing page customers use to connect this business.
  - `logo_asset_id` string

## Response `200`

The updated channel settings.

- AMBChannelSettings: A business's entry points, default locale, and landing-page brand settings. OpenID Connect providers use separate business authentication provider operations. Apple Pay merchant settings use the separate business Apple Pay configuration operations. Supply custom iMessage app metadata on each message.
  - `entry_points` AMBEntryPoint[], required: The entry points customers can use to open a conversation with this business, each matched against the group and intent an inbound message reports.
    - `id` string, required: 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`.
    - `group` string, required: The group value Apple reports on a conversation opened through this entry point. Matched against the `group` the first inbound message carries.
    - `intent` string, required: 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`.
    - `body` string, required: The message text pre-filled for the customer when they open a conversation through this entry point.
  - `default_locale` string, 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_name` string, required: The brand name shown on the Bird-hosted landing page customers use to connect this business.
  - `logo_asset_id` string, required

## Other responses

- `400`: Bad request
- `401`: Authentication required
- `403`: Insufficient permissions
- `404`: Resource not found
- `409`: Resource conflict
- `422`: The request has invalid field values, violates a business rule, or carries a query parameter the endpoint does not declare. Field validation errors use `type: validation_error` and include the affected fields in `details`. Business-rule errors identify the failed rule in `type`.
- `429`: Rate limit exceeded
- `500`: Internal server error
- `503`: The service is temporarily unavailable. If `Retry-After` is present, wait for that delay before retrying; otherwise, retry with exponential backoff. Reuse the same idempotency key and request when retrying a mutation.

---

[API](https://skmtc.dev/messagebird/apis/bird-api.md) · [All operations](https://skmtc.dev/messagebird/apis/bird-api/llms.txt) · [OpenAPI document](https://skmtc.dev/messagebird/apis/bird-api/revisions/3e2a50466454?raw)