Sign inGet Started

Reconnect an Apple business account

POST
/v1/amb/business-accounts/{business_account_id}/reconnect
const result = await bird.amb.businessAccounts.reconnect(
  "abz_01krdgeqcxet5s7t44vh8rt9mg",
);
console.log(result);
Réponse200
{
  "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"
}

Restores the local connection. The retained approval and suspension state still determines whether the account can send. Repeated reconnects return the current account.

Paramètres

business_account_idstring

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

Contenu de la réponse

id
string
obligatoire

Unique identifier for the business record.

apple_business_id
nullable string
obligatoire

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

name
string
obligatoire

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

status
string
obligatoire

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
obligatoire

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

created_at
string
obligatoire

When the business record was created.

updated_at
string
obligatoire

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.

Afficher les attributs enfants
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.

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