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);result = client.amb.business_accounts.update('abz_01krdgeqcxet5s7t44vh8rt9mg', name='Acme Support')
print(result)result, err := client.Amb.BusinessAccounts.Update(ctx, "abz_01krdgeqcxet5s7t44vh8rt9mg", bird.AmbBusinessAccountsUpdateParams{Name: bird.Ptr("Acme Support")})
if err != nil {
log.Fatal(err)
}
fmt.Println(result)$bird->amb->businessAccounts->update('abz_01krdgeqcxet5s7t44vh8rt9mg', (new Model\AMBBusinessAccountUpdate())->setName('Acme Support'));bird amb business-accounts update <business-account-id> \
--apple-business-id b52d6267-2b62-4f8a-8842-0533d0f1dc07curl -X PATCH "https://us1.platform.bird.com/v1/amb/business-accounts/{business_account_id}" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"apple_business_id": "b52d6267-2b62-4f8a-8842-0533d0f1dc07"
}'Respuesta200
{
"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.
Parámetros
business_account_id
string
ID of the Apple Messages for Business record, as returned by the business list.
Cuerpo de la solicitud
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.
Carga de respuesta
id
string
obligatorio
Unique identifier for the business record.
apple_business_id
nullable string
obligatorio
Apple business UUID, or null until supplied. Adding this identifier does not submit the account for review.
name
string
obligatorio
Customer-supplied account name used in Bird. Apple controls the name shown to customers in Messages.
status
string
obligatorio
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
obligatorio
Whether Apple has granted invitation access. Sending also requires an active account and eligible recipient.
created_at
string
obligatorio
When the business record was created.
updated_at
string
obligatorio
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 secundarios
next.kind
string
obligatorio
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
obligatorio
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.
Recursos relacionados
Continúa con la documentación, guías y ejemplos sobre este tema. Los recursos están en inglés.
Comprender el conceptoShould I use a Bird SDK or call the API directly?Seguir la ruta de aprendizajeBuild your first integrationGuía de implementaciónSend your first email
Obtener un resumen de implementación