Skip to main content
POST
Start an AMB registration

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
integer
required

The numeric ID of the account

Body

application/json
amb_onboarding_state
object
required

The registration fields to set.

Response

Success

One in-flight Apple Messages for Business registration. There is at most one per account, which is why these routes are singular and take no ID.

id
integer

The numeric ID of the state.

account_id
integer

The account registering.

inbox_id
integer | null

Set once submit has created the inbox.

mode
string

Which path the registration is taking — for example guided.

current_section
string

Which section of the form the user is on. Starts at mode_picker.

current_substep
string

Where within that section.

captured_data
object

Everything gathered so far. Updates deep-merge into this rather than replacing it.

status
string

in_progress, then submitted_internal once submitted. Only in_progress is writable.

started_at
string

ISO-8601 timestamp.

submitted_internal_at
string | null

When it was submitted to Tied.

submitted_to_apple_at
string | null

When Tied passed it to Apple.

apple_verified_at
string | null

When Apple approved it.

apple_submission_id
string | null

Apple's reference for the submission.