INinkbox
iMessage

Claim Number

Changed on
post/api/v1/imessage/numbers

Request

  • Base URL
    https://api.inkbox.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.inkbox.ai/api/v1/imessage/numbers
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Headers

Idempotency-Keystring required

Unique key used to replay this claim without allocating twice.

Request body

ClaimIMessageNumberRequest required

Response

Successful Response

idstring uuid required
numberstring required
type'dedicated_outbound' required
line_role'personal'
status'active' | 'paused' required
inbound_onlyfalse

Deprecated compatibility field; dedicated lines can initiate.

agent_identity_idstring uuid nullable required
agent_handlestring nullable required

Changes

  • 43519e4ad6d8Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status