Sign inGet Started
शुरू करें
गाइड
API Reference
SDKs
CLI
Knowledge Base
Changelog

Create an Apple Messages for Business record

POST
/v1/amb/businesses
const result = await bird.amb.businesses.create({
  display_name: "Acme Retail",
  apple_business_id: "b52d6267-2b62-4f8a-8842-0533d0f1dc07",
});
console.log(result);
प्रतिक्रिया201
{
  "id": "abz_01krdgeqcxet5s7t44vh8rt9mg",
  "apple_business_id": "b52d6267-2b62-4f8a-8842-0533d0f1dc07",
  "display_name": "Acme Retail",
  "status": "approved",
  "status_reason": null,
  "msp_app": "eu1",
  "invitations_enabled": false,
  "created_at": "2026-08-20T09:14:52Z",
  "updated_at": "2026-08-25T16:42:01Z",
  "next": [
    {
      "kind": "operation"
    }
  ]
}
Creates an Apple Messages for Business record in your workspace. Each Apple Business ID can belong to only one active business record.
The record is always created as draft, including when you supply apple_business_id. Create a submission after uploading the required evidence to move it to submitted.
Request Payload
display_name
string
आवश्यक
The brand name shown for this business record inside Bird.
apple_business_id
string
The Business ID Apple issued for this brand, if you already have it. Supplying it identifies the draft. Submit the completed evidence requirements explicitly when the business is ready for review.
Response Payload
id
string
आवश्यक
Unique identifier for the business record.
apple_business_id
nullable string
आवश्यक
The Apple Business ID stored for this brand. Null until supplied. New values must be UUIDs; legacy records can contain a non-UUID identifier until corrected. Supplying or correcting the identifier leaves the status unchanged; an evidence submission moves the record to submitted.
display_name
string
आवश्यक
The brand name shown for this business record inside Bird. This is not the name Apple shows to customers; that name comes from the Apple Business Register account behind the Business ID.
status
string
आवश्यक
Where the business record stands with Apple.
Possible values: draft, submitted, in_review, approved, rejected, suspended
status_reason
nullable string
आवश्यक
Free-text detail behind status, such as why Apple's review ended in rejected. Null when Bird has recorded no detail for the current status.
msp_app
string
आवश्यक
The regional Messaging Service Provider application this business is registered under.
Possible values: eu1, us1
invitations_enabled
boolean
आवश्यक
Whether this business can send invitations. Apple grants invitation access separately from approving the business itself, so this can be false on an approved business.
created_at
string
आवश्यक
When the business record was created.
updated_at
string
आवश्यक
When the business record was last changed.
next
array of object
Onboarding actions computed from the business status and Apple Business ID. Present on create, update and single-business reads; omitted on lists. Approved businesses have no onboarding action. Evidence readiness is not inferred from this record; prepare and upload the required files before submission.
चाइल्ड एट्रिब्यूट दिखाएँ
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.

संबंधित संसाधन

इस विषय के लिए डॉक्यूमेंटेशन, गाइड और उदाहरणों के साथ आगे बढ़ें। संसाधन अंग्रेज़ी में हैं।

कॉन्सेप्ट समझेंShould I use a Bird SDK or call the API directly?लर्निंग पाथ फ़ॉलो करेंBuild your first integrationइम्प्लीमेंटेशन गाइडSend your first email
इम्प्लीमेंटेशन ब्रीफ़ पाएँ