amb-business-accounts

Submit an Apple Messages for Business business for review

Submits an account for review, making its name, Apple UUID and three uploaded evidence attachments available to Bird staff. This does not approve the account.

post/v1/amb/business-accounts/{business_account_id}/submissions

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/amb/business-accounts/{business_account_id}/submissions
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Path parameters

business_account_idstring required
Example:abz_01krdgeqcxet5s7t44vh8rt9mg

Headers

Idempotency-Keystring

Client-supplied key. On operations supporting request deduplication, a retained response is replayed for duplicate requests with the same key within the idempotency window (3 hours by default). This protection requires a workspace, organization, or staff-account scope. User-only and unscoped unauthenticated operations, streams, and operations with a separate replay contract do not use this response replay.

On a supported operation, if idempotency protection is unavailable before execution, the API returns 503 IdempotencyUnavailable (E01033) without executing this attempt. Retry with backoff using the same key and request. An operation that takes effect before its response is retained can still execute again on retry.

Two distinct 409 errors signal misuse:

  • request_in_progress (E01004): The same key is currently being processed by a concurrent request. Wait briefly and retry. The lock expires within 30 seconds.
  • idempotency_key_reuse (E01005): The same key has already completed against a different request body or method. Generate a new key.

Recommended key format is <event-type>/<entity-id> (for example welcome-user/usr_abc123).

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Request body

readiness_attachment_idstring required
use_cases_attachment_idstring required
video_attachment_idstring required

Example request

{
  "readiness_attachment_id": "tca_01krdgeqcxet5s7t44vh8rt9mg",
  "use_cases_attachment_id": "tca_01krdgeqcxet5s7t44vh8rt9mg",
  "video_attachment_id": "tca_01krdgeqcxet5s7t44vh8rt9mg"
}

Response

The submission with its frozen evidence manifest.

idstring required
business_account_idstring required
apple_business_idstring uuid required

The Apple business UUID frozen when this attempt was submitted.

namestring required

The customer-supplied Bird account name frozen when this attempt was submitted.

status'submitted' | 'in_review' | 'approved' | 'rejected' required

State of this review attempt. Later suspension or disconnection does not change an approved attempt.

status_reasonstring nullable required

Review feedback on this attempt, such as the reason Apple rejected it. May contain basic Markdown, such as emphasis and lists.

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "id": "abs_01krdgeqcxet5s7t44vh8rt9mg",
  "business_account_id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
  "readiness_attachment": {
    "created_at": "2026-05-20T09:14:52Z",
    "updated_at": "2026-05-25T16:42:01Z",
    "id": "tca_01krdgeqcxet5s7t44vh8rt9mg"
  },
  "use_cases_attachment": {
    "created_at": "2026-05-20T09:14:52Z",
    "updated_at": "2026-05-25T16:42:01Z",
    "id": "tca_01krdgeqcxet5s7t44vh8rt9mg"
  },
  "video_attachment": {
    "created_at": "2026-05-20T09:14:52Z",
    "updated_at": "2026-05-25T16:42:01Z",
    "id": "tca_01krdgeqcxet5s7t44vh8rt9mg"
  },
  "status": "submitted"
}

Changes

No recorded changes to this operation across all 3 revisions of this API.