Sign inGet Started

Create an Apple Messages for Business record

POST
/v1/amb/business-accounts
const result = await bird.amb.businessAccounts.create({
  name: "Acme Retail",
  apple_business_id: "b52d6267-2b62-4f8a-8842-0533d0f1dc07",
});
console.log(result);
Resposta201
{
  "id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
  "apple_business_id": "b52d6267-2b62-4f8a-8842-0533d0f1dc07",
  "name": "Acme Retail",
  "status": "active",
  "invitations_enabled": false,
  "created_at": "2026-08-20T09:14:52Z",
  "updated_at": "2026-08-25T16:42:01Z",
  "next": [
    {
      "kind": "operation"
    }
  ],
  "account_review_status": "approved"
}

Creates an Apple Messages for Business record in your workspace. Each Apple Business ID can belong to only one retained business record in this region. Disconnecting an account does not release its identifier.

The account starts with status: pending and no account_review_status, including when you supply apple_business_id. Upload the required evidence and create a submission to begin review. The account remains pending until approved; its submission records review progress.

Corpo da requisição

name
string
obrigatório

The brand name shown for this business record inside Bird.

apple_business_id
string

The Business ID Apple issued for this brand, if you already have it. Supplying it identifies the draft. Submit the completed evidence requirements explicitly when the business is ready for review.

Payload de resposta

id
string
obrigatório

Unique identifier for the business record.

apple_business_id
nullable string
obrigatório

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

name
string
obrigatório

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

status
string
obrigatório

Operational state of the business account.

Possible values: pending, active, suspended, disconnected

status_reason
string

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_enabled
boolean
obrigatório

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

created_at
string
obrigatório

When the business record was created.

updated_at
string
obrigatório

When the business record was last changed.

next
array of object

Next setup actions on create, update and single-account reads. Active accounts return an empty array. Lists omit this field.

Mostrar atributos secundários
account_review_status
string

Latest recorded review outcome. Absent before the first submission.

Possible values (may grow over time): pending, approved, rejected

finish_setup_url
string

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