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);
Réponse201
{
  "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.

Paramètres

business_account_idstring

Corps de la requête

readiness_attachment_id
string
obligatoire

Uploaded PDF attachment containing the business readiness assessment.

use_cases_attachment_id
string
obligatoire

Uploaded PDF attachment describing the proposed customer use cases.

video_attachment_id
string
obligatoire

Uploaded MP4 attachment demonstrating the customer experience.

Contenu de la réponse

id
string
obligatoire
business_account_id
string
obligatoire
apple_business_id
string
obligatoire

The Apple business UUID frozen when this attempt was submitted.

name
string
obligatoire

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

readiness_attachment
object
obligatoire
Afficher les attributs enfants
use_cases_attachment
object
obligatoire
Afficher les attributs enfants
video_attachment
object
obligatoire
Afficher les attributs enfants
status
string
obligatoire

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

status_reason
nullable string
obligatoire

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

created_at
string
obligatoire
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.

Afficher les attributs enfants
updated_at
string
obligatoire

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.