Sign inGet Started
Get started
Guides
API Reference
SDKs
CLI
Knowledge Base
Changelog

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);
Response200
{
  "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.

Parameters

business_account_idstring

Response Payload

id
string
required

Unique identifier for the business record.

apple_business_id
nullable string
required

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

name
string
required

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

status
string
required

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.

invitations_enabled
boolean
required

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

created_at
string
required

When the business record was created.

updated_at
string
required

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.

Show child attributes
next.kind
string
required

What you do about this step.

  • operation: call the operation named in operation, then read again.
  • external: act somewhere this API does not reach, then read again.
  • wait: nothing is asked of you, so read again later.
  • terminal: nothing you do resolves this, so stop retrying.

Tolerate a value you do not recognize: show the description and offer no action.

Possible values (may grow over time): operation, external, wait, terminal

next.description
string
required

A short, human-readable label for the step, suitable for display.

next.operation
string

The operationId to call. Present only when kind is operation. The operation's own schema says how to call it; this says only which one, and what to address it with.

next.params
object

The parameters that address the operation, by name: {"sender_id": "…"} for an operation on /v1/sms/senders/{sender_id}/requirements. A parameter the operation takes in its query string is given the same way, so an operation addressed as ?subject_id= carries {"subject_id": "…"}. Every parameter the call needs is here, whether its value came from the thing you were acting on or is fixed for this step, so you can make the call from this object alone. Present only when kind is operation and the operation names a subject. A request body, when the operation takes one, is described by the operation's own schema and never appears here.

next.url
string

A URL to open. Present only when kind is external, and only when the step has one. An external step whose description says to go and do something with no URL to open is normal.

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.

Related resources

Continue with the documentation, guides and examples for this topic.

Get an implementation brief