Sign inGet Started

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);
Resposta201
{
  "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",
  "decided_by": null,
  "next": [
    {
      "kind": "operation"
    }
  ]
}

Submits an account for review and queues an automated review of its three evidence attachments. The review can reject the attempt with the changes needed. Otherwise Bird staff review it and relay it to Apple when it is ready. Each submission spends one of the organization's daily automated reviews (amb_reviews_daily_max) and one of the account's 10 daily reviews. This does not approve the account.

Parâmetros

business_account_idstring

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

Corpo da requisição

readiness_attachment_id
string
obrigatório

Uploaded PDF attachment containing the business readiness assessment.

use_cases_attachment_id
string
obrigatório

Uploaded PDF attachment describing the proposed customer use cases.

video_attachment_id
string
obrigatório

Uploaded MP4 attachment demonstrating the customer experience.

Payload de resposta

id
string
obrigatório
business_account_id
string
obrigatório
apple_business_id
string
obrigatório

The Apple business UUID frozen when this attempt was submitted.

name
string
obrigatório

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

readiness_attachment
object
obrigatório

A supporting document uploaded for compliance answers or SMS registrations, including number ownership evidence, 10DLC campaign evidence and toll-free verification opt-in screenshots. Reference its ID from the relevant answer or registration attachment field to submit it as evidence.

Mostrar atributos secundários
use_cases_attachment
object
obrigatório

A supporting document uploaded for compliance answers or SMS registrations, including number ownership evidence, 10DLC campaign evidence and toll-free verification opt-in screenshots. Reference its ID from the relevant answer or registration attachment field to submit it as evidence.

Mostrar atributos secundários
video_attachment
object
obrigatório

A supporting document uploaded for compliance answers or SMS registrations, including number ownership evidence, 10DLC campaign evidence and toll-free verification opt-in screenshots. Reference its ID from the relevant answer or registration attachment field to submit it as evidence.

Mostrar atributos secundários
status
string
obrigatório

The review outcome of this attempt. Earlier attempts retain their outcome when a new attempt is submitted.

Possible values: submitted, in_review, approved, rejected

status_reason
nullable string
obrigatório

Review feedback on this attempt, such as the automated review's feedback or the reason Apple rejected it. May contain basic Markdown, such as emphasis, lists and links.

decided_by
nullable string
obrigatório

Who recorded this attempt's outcome, automated_review when Bird's automated review rejected it or staff. Null while the attempt waits, and for outcomes recorded before automated reviews.

created_at
string
obrigatório
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.

Mostrar atributos secundários
updated_at
string
obrigatório