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

Submit an Apple Messages for Business business for review

POST
/v1/amb/business-accounts/{business_account_id}/submissions
const result = await bird.amb.businessAccounts.submissions.create(
  "abz_01krdgeqcxet5s7t44vh8rt9mg",
  {
    readiness_attachment_id: "tca_01krdgeqcxet5s7t44vh8rt9mg",
    use_cases_attachment_id: "tca_01krdgeqcxet5s7t44vh8rt9mh",
    video_attachment_id: "tca_01krdgeqcxet5s7t44vh8rt9mj",
  },
);
console.log(result);
Response201
{
  "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",
    "status": "draft"
  },
  "use_cases_attachment": {
    "created_at": "2026-05-20T09:14:52Z",
    "updated_at": "2026-05-25T16:42:01Z",
    "id": "tca_01krdgeqcxet5s7t44vh8rt9mg",
    "status": "draft"
  },
  "video_attachment": {
    "created_at": "2026-05-20T09:14:52Z",
    "updated_at": "2026-05-25T16:42:01Z",
    "id": "tca_01krdgeqcxet5s7t44vh8rt9mg",
    "status": "draft"
  },
  "status": "submitted",
  "next": [
    {
      "kind": "operation"
    }
  ]
}
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.
Parameters
business_account_id
string
Request Payload
readiness_attachment_id
string
required
Uploaded PDF attachment containing the business readiness assessment.
use_cases_attachment_id
string
required
Uploaded PDF attachment describing the proposed customer use cases.
video_attachment_id
string
required
Uploaded MP4 attachment demonstrating the customer experience.
Response Payload
id
string
required
business_account_id
string
required
apple_business_id
string
required
The Apple business UUID frozen when this attempt was submitted.
name
string
required
The customer-supplied Bird account name frozen when this attempt was submitted.
readiness_attachment
object
required
Show child attributes
readiness_attachment.created_at
string
required
readiness_attachment.updated_at
string
required
readiness_attachment.id
string
required
readiness_attachment.filename
string
required
The uploaded file's name.
readiness_attachment.content_type
string
required
The file's content type, determined from its contents.
readiness_attachment.size_bytes
integer
required
The file's size in bytes.
readiness_attachment.description
string
A short note describing what the file shows.
readiness_attachment.status
string
required
Lifecycle of an attachment. draft is a file that has been uploaded but nothing has been registered or submitted with it yet, and it is discarded at its expires_at. attached means at least one registration has cited it, so it is kept permanently and can no longer be deleted.
Possible values: draft, attached
readiness_attachment.download_url
string
required
Short-lived signed URL for downloading or previewing the attachment. Valid for 24 hours from when the resource was fetched; request a fresh resource to obtain a new URL after expiry. Do not cache beyond download_url_expires_at. Registration authorities (10DLC and toll-free carriers) retrieve evidence via a separate, longer-lived token; this URL is not that token.
readiness_attachment.preview_url
string
Optional signed URL for inline viewing on an isolated storage origin. Valid for one hour; fetch the attachment again to refresh it.
readiness_attachment.download_url_expires_at
string
required
When download_url expires. Both fields are always present; the server returns an error rather than omitting them.
readiness_attachment.expires_at
nullable string
required
When this attachment is discarded if nothing is registered or submitted with it. Null once its status is attached.
use_cases_attachment
object
required
Show child attributes
use_cases_attachment.created_at
string
required
use_cases_attachment.updated_at
string
required
use_cases_attachment.id
string
required
use_cases_attachment.filename
string
required
The uploaded file's name.
use_cases_attachment.content_type
string
required
The file's content type, determined from its contents.
use_cases_attachment.size_bytes
integer
required
The file's size in bytes.
use_cases_attachment.description
string
A short note describing what the file shows.
use_cases_attachment.status
string
required
Lifecycle of an attachment. draft is a file that has been uploaded but nothing has been registered or submitted with it yet, and it is discarded at its expires_at. attached means at least one registration has cited it, so it is kept permanently and can no longer be deleted.
Possible values: draft, attached
use_cases_attachment.download_url
string
required
Short-lived signed URL for downloading or previewing the attachment. Valid for 24 hours from when the resource was fetched; request a fresh resource to obtain a new URL after expiry. Do not cache beyond download_url_expires_at. Registration authorities (10DLC and toll-free carriers) retrieve evidence via a separate, longer-lived token; this URL is not that token.
use_cases_attachment.preview_url
string
Optional signed URL for inline viewing on an isolated storage origin. Valid for one hour; fetch the attachment again to refresh it.
use_cases_attachment.download_url_expires_at
string
required
When download_url expires. Both fields are always present; the server returns an error rather than omitting them.
use_cases_attachment.expires_at
nullable string
required
When this attachment is discarded if nothing is registered or submitted with it. Null once its status is attached.
video_attachment
object
required
Show child attributes
video_attachment.created_at
string
required
video_attachment.updated_at
string
required
video_attachment.id
string
required
video_attachment.filename
string
required
The uploaded file's name.
video_attachment.content_type
string
required
The file's content type, determined from its contents.
video_attachment.size_bytes
integer
required
The file's size in bytes.
video_attachment.description
string
A short note describing what the file shows.
video_attachment.status
string
required
Lifecycle of an attachment. draft is a file that has been uploaded but nothing has been registered or submitted with it yet, and it is discarded at its expires_at. attached means at least one registration has cited it, so it is kept permanently and can no longer be deleted.
Possible values: draft, attached
video_attachment.download_url
string
required
Short-lived signed URL for downloading or previewing the attachment. Valid for 24 hours from when the resource was fetched; request a fresh resource to obtain a new URL after expiry. Do not cache beyond download_url_expires_at. Registration authorities (10DLC and toll-free carriers) retrieve evidence via a separate, longer-lived token; this URL is not that token.
video_attachment.preview_url
string
Optional signed URL for inline viewing on an isolated storage origin. Valid for one hour; fetch the attachment again to refresh it.
video_attachment.download_url_expires_at
string
required
When download_url expires. Both fields are always present; the server returns an error rather than omitting them.
video_attachment.expires_at
nullable string
required
When this attachment is discarded if nothing is registered or submitted with it. Null once its status is attached.
status
string
required
The review outcome of this attempt. Earlier attempts retain their outcome when a new attempt is submitted.
status_reason
nullable string
required
created_at
string
required
next
array of object
Read the parent business account for current eligibility and next actions. Present on create responses and each customer submission-list item; historical attempts do not establish current account state.
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.
updated_at
string
required

Related resources

Continue with the documentation, guides and examples for this topic. Resources are in English.

Understand the conceptShould I use a Bird SDK or call the API directly?Follow the learning pathBuild your first integrationImplementation guideSend your first email
Get an implementation brief