Sign inGet Started
Jetzt starten
Anleitungen
API-Referenz
SDKs
CLI
Wissensdatenbank
Changelog

Update an Apple Messages for Business record

PATCH
/v1/amb/business-accounts/{business_account_id}
const result = await bird.amb.businessAccounts.update(
  "abz_01krdgeqcxet5s7t44vh8rt9mg",
  { name: "Acme Support" },
);
console.log(result);
Antwort200
{
  "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"
}

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.

Parameter

business_account_idstring

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

Anfrage-Nutzlast

name
string

The brand name shown for this business record inside Bird.

apple_business_id
string

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.

Antwort-Payload

id
string
erforderlich

Unique identifier for the business record.

apple_business_id
nullable string
erforderlich

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

name
string
erforderlich

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

status
string
erforderlich

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
erforderlich

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

created_at
string
erforderlich

When the business record was created.

updated_at
string
erforderlich

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.

Untergeordnete Attribute anzeigen
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.

Verwandte Ressourcen

Weiter mit der Dokumentation, Anleitungen und Beispielen zu diesem Thema.

Implementierungs-Briefing erhalten