Save registration progress
Records where the user is and what they have entered. captured_data is deep-merged into what is stored, so send only the fields from this step — you do not have to resend the whole form, and you cannot clear a field by omitting it.
Once the registration is submitted it becomes read-only and further updates return a 422. Administrator only.
Authorizations
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
The numeric ID of the account
Body
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.
The numeric ID of the state.
The account registering.
Set once submit has created the inbox.
Which path the registration is taking — for example guided.
Which section of the form the user is on. Starts at mode_picker.
Where within that section.
Everything gathered so far. Updates deep-merge into this rather than replacing it.
in_progress, then submitted_internal once submitted. Only in_progress is writable.
ISO-8601 timestamp.
When it was submitted to Tied.
When Tied passed it to Apple.
When Apple approved it.
Apple's reference for the submission.