amb-business-accounts

Update an Apple Messages for Business record

Changes your workspace's Apple Messages for Business record. Fields you omit are left as they are.

Sending apple_business_id identifies the draft but does not submit it. Create a submission with all three evidence attachments when the record is ready for review.

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

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/amb/business-accounts/{business_account_id}
  • 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

namestring

The brand name shown for this business record inside Bird.

apple_business_idstring uuid

The Business ID Apple issued for this brand. Accepted only while the account has not yet been submitted and is connected. Updating it does not submit the business.

Example request

{
  "name": "Acme Retail",
  "apple_business_id": "b52d6267-2b62-4f8a-8842-0533d0f1dc07"
}

Response

The updated Apple Messages for Business record.

idstring required
apple_business_idstring uuid nullable required

Apple business UUID, or null until supplied. Adding this identifier does not submit the account for review.

namestring required

Customer-supplied account name used in Bird. Apple controls the name shown to customers in Messages.

status'pending' | 'active' | 'suspended' | 'disconnected' required

Pending accounts need setup or review. Active accounts have recorded approval. Suspended accounts retain their recorded suspension. Configured, connected accounts can exchange messages regardless of review status; Apple decides whether to accept outgoing requests. Disconnected accounts retain their identity and history but cannot exchange new messages until reconnected.

status_reasonstring

Reason for the current operational suspension, when recorded. Review feedback is retained on the submission. May contain basic Markdown, such as emphasis and lists.

invitations_enabledboolean required

Whether Apple has granted invitation access. Sending also requires a configured, connected account and eligible recipient.

created_atstring date-time required

When the business record was created.

updated_atstring date-time required

When the business record was last changed.

account_review_statusstring

Latest review outcome recorded by Bird staff.

finish_setup_urlstring uri

Bird dashboard URL for completing setup. Present only when customer action is available.

Example response

{
  "id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
  "apple_business_id": "b52d6267-2b62-4f8a-8842-0533d0f1dc07",
  "name": "Acme Retail",
  "status": "active",
  "created_at": "2026-08-20T09:14:52Z",
  "updated_at": "2026-08-25T16:42:01Z",
  "account_review_status": "approved"
}

Changes

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