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);

result = client.amb.business_accounts.submissions.create(
    'abz_01krdgeqcxet5s7t44vh8rt9mg',
    readiness_attachment_id='tca_01krdgeqcxet5s7t44vh8rt9mg',
    use_cases_attachment_id='tca_01krdgeqcxet5s7t44vh8rt9mh',
    video_attachment_id='tca_01krdgeqcxet5s7t44vh8rt9mj',
)
print(result)

result, err := client.Amb.BusinessAccounts.Submissions.Create(ctx, "abz_01krdgeqcxet5s7t44vh8rt9mg", bird.AmbBusinessAccountsSubmissionsCreateParams{
	ReadinessAttachmentID: "tca_01krdgeqcxet5s7t44vh8rt9mg",
	UseCasesAttachmentID:  "tca_01krdgeqcxet5s7t44vh8rt9mh",
	VideoAttachmentID:     "tca_01krdgeqcxet5s7t44vh8rt9mj",
})
if err != nil {
	log.Fatal(err)
}
fmt.Println(result)

$bird->amb->businessAccounts->submissions->create(
    'abz_01krdgeqcxet5s7t44vh8rt9mg',
    (new Model\AMBBusinessAccountSubmissionCreate())
        ->setReadinessAttachmentId('tca_01krdgeqcxet5s7t44vh8rt9mg')
        ->setUseCasesAttachmentId('tca_01krdgeqcxet5s7t44vh8rt9mh')
        ->setVideoAttachmentId('tca_01krdgeqcxet5s7t44vh8rt9mj'),
);

bird amb business-accounts submissions create <business-account-id> \
  --readiness-attachment-id tca_01krdgeqcxet5s7t44vh8rt9mg \
  --use-cases-attachment-id tca_01krdgeqcxet5s7t44vh8rt9mg \
  --video-attachment-id tca_01krdgeqcxet5s7t44vh8rt9mg

curl -X POST "https://us1.platform.bird.com/v1/amb/business-accounts/{business_account_id}/submissions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "readiness_attachment_id": "tca_01krdgeqcxet5s7t44vh8rt9mg",
    "use_cases_attachment_id": "tca_01krdgeqcxet5s7t44vh8rt9mg",
    "video_attachment_id": "tca_01krdgeqcxet5s7t44vh8rt9mg"
  }'

响应201

{
  "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.

参数

business_account_id

string

请求载荷

readiness_attachment_id

string

必填

Uploaded PDF attachment containing the business readiness assessment.

use_cases_attachment_id

string

必填

Uploaded PDF attachment describing the proposed customer use cases.

video_attachment_id

string

必填

Uploaded MP4 attachment demonstrating the customer experience.

响应载荷

string

必填

business_account_id

string

必填

apple_business_id

string

必填

The Apple business UUID frozen when this attempt was submitted.

name

string

必填

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

readiness_attachment

object

必填

显示子属性

readiness_attachment.created_at

string

必填

readiness_attachment.updated_at

string

必填

readiness_attachment.id

string

必填

readiness_attachment.filename

string

必填

The uploaded file's name.

readiness_attachment.content_type

string

必填

The file's content type, determined from its contents.

readiness_attachment.size_bytes

integer

必填

The file's size in bytes.

readiness_attachment.description

string

A short note describing what the file shows.

readiness_attachment.status

string

必填

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

必填

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

必填

When download_url expires. Both fields are always present; the server returns an error rather than omitting them.

readiness_attachment.expires_at

nullable string

必填

When this attachment is discarded if nothing is registered or submitted with it. Null once its status is attached.

use_cases_attachment

object

必填

显示子属性

use_cases_attachment.created_at

string

必填

use_cases_attachment.updated_at

string

必填

use_cases_attachment.id

string

必填

use_cases_attachment.filename

string

必填

The uploaded file's name.

use_cases_attachment.content_type

string

必填

The file's content type, determined from its contents.

use_cases_attachment.size_bytes

integer

必填

The file's size in bytes.

use_cases_attachment.description

string

A short note describing what the file shows.

use_cases_attachment.status

string

必填

Possible values: draft, attached

use_cases_attachment.download_url

string

必填

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

必填

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

必填

When this attachment is discarded if nothing is registered or submitted with it. Null once its status is attached.

video_attachment

object

必填

显示子属性

video_attachment.created_at

string

必填

video_attachment.updated_at

string

必填

video_attachment.id

string

必填

video_attachment.filename

string

必填

The uploaded file's name.

video_attachment.content_type

string

必填

The file's content type, determined from its contents.

video_attachment.size_bytes

integer

必填

The file's size in bytes.

video_attachment.description

string

A short note describing what the file shows.

video_attachment.status

string

必填

Possible values: draft, attached

video_attachment.download_url

string

必填

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

必填

When download_url expires. Both fields are always present; the server returns an error rather than omitting them.

video_attachment.expires_at

nullable string

必填

When this attachment is discarded if nothing is registered or submitted with it. Null once its status is attached.

status

string

必填

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

status_reason

nullable string

必填

created_at

string

必填

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.

显示子属性

next.kind

string

必填

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

必填

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

必填

相关资源

继续查阅此主题的文档、指南和示例。资源为英文。

理解概念Should I use a Bird SDK or call the API directly?跟随学习路径Build your first integration 实施指南Send your first email

获取实施简报

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);

result = client.amb.business_accounts.submissions.create(
    'abz_01krdgeqcxet5s7t44vh8rt9mg',
    readiness_attachment_id='tca_01krdgeqcxet5s7t44vh8rt9mg',
    use_cases_attachment_id='tca_01krdgeqcxet5s7t44vh8rt9mh',
    video_attachment_id='tca_01krdgeqcxet5s7t44vh8rt9mj',
)
print(result)

result, err := client.Amb.BusinessAccounts.Submissions.Create(ctx, "abz_01krdgeqcxet5s7t44vh8rt9mg", bird.AmbBusinessAccountsSubmissionsCreateParams{
	ReadinessAttachmentID: "tca_01krdgeqcxet5s7t44vh8rt9mg",
	UseCasesAttachmentID:  "tca_01krdgeqcxet5s7t44vh8rt9mh",
	VideoAttachmentID:     "tca_01krdgeqcxet5s7t44vh8rt9mj",
})
if err != nil {
	log.Fatal(err)
}
fmt.Println(result)

$bird->amb->businessAccounts->submissions->create(
    'abz_01krdgeqcxet5s7t44vh8rt9mg',
    (new Model\AMBBusinessAccountSubmissionCreate())
        ->setReadinessAttachmentId('tca_01krdgeqcxet5s7t44vh8rt9mg')
        ->setUseCasesAttachmentId('tca_01krdgeqcxet5s7t44vh8rt9mh')
        ->setVideoAttachmentId('tca_01krdgeqcxet5s7t44vh8rt9mj'),
);

bird amb business-accounts submissions create <business-account-id> \
  --readiness-attachment-id tca_01krdgeqcxet5s7t44vh8rt9mg \
  --use-cases-attachment-id tca_01krdgeqcxet5s7t44vh8rt9mg \
  --video-attachment-id tca_01krdgeqcxet5s7t44vh8rt9mg

curl -X POST "https://us1.platform.bird.com/v1/amb/business-accounts/{business_account_id}/submissions" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "readiness_attachment_id": "tca_01krdgeqcxet5s7t44vh8rt9mg",
    "use_cases_attachment_id": "tca_01krdgeqcxet5s7t44vh8rt9mg",
    "video_attachment_id": "tca_01krdgeqcxet5s7t44vh8rt9mg"
  }'

响应201

{
  "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"
    }
  ]
}