INinkbox
Identities

Create an identity with its mandatory mailbox and tunnel, optionally also a phone number and/or attached vault secret access

Changed on
post/api/v1/identities/

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/identities/
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Request body

agent_handlestring required

Agent handle for the identity. A leading '@' is stripped automatically and the handle must be globally unique.

display_namestring nullable

Human-readable display name for the identity. Defaults to agent_handle if omitted.

descriptionstring nullable

Free-form description of what the identity is. Visible only to your org.

imessage_enabledboolean

Whether this identity can be reached through the shared iMessage service. Defaults to false; set true to opt in.

contact_sharing_enabledboolean

Whether an attached dedicated iMessage line automatically shares this identity's name and optional avatar. Defaults to true.

claim_imessage_numbertrue nullable

Claim and attach a dedicated iMessage line during identity creation. Requires imessage_enabled=true.

Example request

{
  "phone_number": {
    "forwarding_phone_number": "+15551234567",
    "forwarding_sip_uri": "sip:line@voice.example.com"
  }
}

Response

Successful Response

idstring uuid required
organization_idstring required
agent_handlestring required
display_namestring nullable
descriptionstring nullable
status'active' | 'paused' | 'deleted'
whatsapp_enabledboolean
whatsapp_configuredboolean
whatsapp_numberstring nullable
imessage_enabledboolean
contact_sharing_enabledboolean
imessage_filter_mode'whitelist' | 'blacklist'
mail_filter_mode'whitelist' | 'blacklist'
phone_filter_mode'whitelist' | 'blacklist'
slack_filter_mode'whitelist' | 'blacklist'
slack_inbound_filter_mode'whitelist' | 'blacklist'
slack_outbound_filter_mode'whitelist' | 'blacklist'
mail_inbound_filter_mode'whitelist' | 'blacklist'
mail_outbound_filter_mode'whitelist' | 'blacklist'
phone_inbound_filter_mode'whitelist' | 'blacklist'
phone_outbound_filter_mode'whitelist' | 'blacklist'
email_addressstring email nullable
has_avatarboolean
created_atstring date-time required
updated_atstring date-time required
signing_key_configuredboolean
signing_key_created_atstring date-time nullable

Changes

  • 7e848337e8bfRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 43519e4ad6d8Revision changes
    • info

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

    • info

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