Phone Numbers

Save A2P brand and campaign details

Save the brand and campaign details WITHOUT submitting them.

Nothing reaches a carrier and nothing is charged. This is the draft step - call it as often as you like, then submit once with /a2p/register.

The save REPLACES what was there rather than merging, so send the whole object each time.

post/phone-numbers/a2p/inputs

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/phone-numbers/a2p/inputs
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

brand_inputsobject

The legal business behind the messages: legal_business_name (required before registration can start), plus ein, address, website, business_type, vertical and whatever else the carrier registry asks for.

campaign_inputsobject

What the messages are: use_case, message_samples and opt_in_method are the three the platform checks for before it considers the inputs complete.

Response

Successful Response

dataPhoneNumberPayload required

An open envelope for a purchase result, a release, or an A2P job.

Open on purpose. A purchase returns the stored row (whose capability and provider-metadata keys differ per provider), a workflow start returns a workflow_id, and the A2P reconcile returns per-number outcomes that grow as carriers add statuses. Pinning it would silently drop whatever the provider reported that this contract had not caught up on.

Changes

No recorded changes to this operation across all 2 revisions of this API.