/
IN
inkbox
Search skmtc…
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
A2A
21
A2A Invitations
7
Agent Signup
7
API Keys
6
Billing
22
Brand
7
Campaign
8
Contact Access
3
Contact Communication Policies
3
Contact Correspondence
1
Contact Memory
6
Contact Rules
12
Contacts
13
Domains
11
Drafts
10
Hosted Call Agent
17
Identities
45
get
/api/v1/identities/
List Identities
post
/api/v1/identities/
Create an identity with its mandatory mailbox and tunnel, optionally also a phone number and/or attached vault secret access
get
/api/v1/identities/{agent_handle}/contacts/{contact_id}/access
Get Identity Contact Access
patch
/api/v1/identities/{agent_handle}/contacts/{contact_id}/access
Patch Identity Contact Access
get
/api/v1/identities/self
Get Current Identity
get
/api/v1/identities/{agent_handle}/channel-status
Get Identity Channel Status
get
/api/v1/identities/{agent_handle}
Get Identity
delete
/api/v1/identities/{agent_handle}
Delete Identity
patch
/api/v1/identities/{agent_handle}
Update Identity
get
/api/v1/identities/{agent_handle}/contact-communication-policies
List Contact Communication Policies
get
/api/v1/identities/{agent_handle}/contact-permissions
List Identity Contact Permissions
get
/api/v1/identities/{agent_handle}/contacts/{contact_id}/permissions
Get Identity Contact Permissions
patch
/api/v1/identities/{agent_handle}/contacts/{contact_id}/permissions
Patch Identity Contact Permissions
get
/api/v1/identities/{agent_handle}/companion
Get Companion
patch
/api/v1/identities/{agent_handle}/companion
Patch Companion
get
/api/v1/identities/{agent_handle}/companion/conversations
List Companion Conversations
get
/api/v1/identities/{agent_handle}/companion/activations/{activation_id}/messages
Get Companion History
get
/api/v1/identities/{agent_handle}/slack-contact-rules
List Slack Contact Rules
post
/api/v1/identities/{agent_handle}/slack-contact-rules
Create Slack Contact Rule
get
/api/v1/identities/{agent_handle}/slack-contact-rules/{rule_id}
Get Slack Contact Rule
delete
/api/v1/identities/{agent_handle}/slack-contact-rules/{rule_id}
Delete Slack Contact Rule
patch
/api/v1/identities/{agent_handle}/slack-contact-rules/{rule_id}
Update Slack Contact Rule
get
/api/v1/identities/{agent_handle}/domain-affiliation
Get Affiliation
put
/api/v1/identities/{agent_handle}/domain-affiliation
Set Affiliation
delete
/api/v1/identities/{agent_handle}/domain-affiliation
Remove Affiliation
get
/api/v1/identities/{agent_handle}/avatar
Get Identity Avatar
put
/api/v1/identities/{agent_handle}/avatar
Upload Identity Avatar
delete
/api/v1/identities/{agent_handle}/avatar
Delete Identity Avatar
get
/api/v1/identities/{agent_handle}/avatar-metadata
Get Identity Avatar Metadata
post
/api/v1/identities/{agent_handle}/avatar/staged
Set Identity Avatar From Staged Media
delete
/api/v1/identities/{agent_handle}/phone_number
Release Identity Phone Number
post
/api/v1/identities/{agent_handle}/imessage_number
Connect Identity Imessage Number
delete
/api/v1/identities/{agent_handle}/imessage_number
Disconnect Identity Imessage Number
get
/api/v1/identities/{agent_handle}/mail-contact-rules
List Mail Contact Rules
post
/api/v1/identities/{agent_handle}/mail-contact-rules
Create Mail Contact Rule
get
/api/v1/identities/{agent_handle}/mail-contact-rules/{rule_id}
Get Mail Contact Rule
delete
/api/v1/identities/{agent_handle}/mail-contact-rules/{rule_id}
Delete Mail Contact Rule
patch
/api/v1/identities/{agent_handle}/mail-contact-rules/{rule_id}
Update Mail Contact Rule
get
/api/v1/identities/{agent_handle}/phone-contact-rules
List Phone Contact Rules
post
/api/v1/identities/{agent_handle}/phone-contact-rules
Create Phone Contact Rule
get
/api/v1/identities/{agent_handle}/phone-contact-rules/{rule_id}
Get Phone Contact Rule
delete
/api/v1/identities/{agent_handle}/phone-contact-rules/{rule_id}
Delete Phone Contact Rule
patch
/api/v1/identities/{agent_handle}/phone-contact-rules/{rule_id}
Update Phone Contact Rule
get
/api/v1/identities/{agent_handle}/signing-key
Get Identity Signing Key Status
post
/api/v1/identities/{agent_handle}/signing-key
Create Or Rotate Identity Signing Key
Identity Access
3
iMessage
21
iMessage Contact Rules
6
iMessage Router
9
Imports
6
Mailboxes
4
Message Sends
1
Messages
13
Note Access
3
Notes
5
Organization Domains
5
Phone Calls
12
Phone Numbers
5
Phone Transcripts
2
Privacy
1
Resource Links
1
Search
2
Signing Keys
2
Slack
55
SMS Opt-Ins
4
Text Messages
10
Threads
9
Tunnels
4
Vault
4
Vault Keys
3
Vault Secret Access
3
Vault Secrets
5
Webhooks
11
WhatsApp
14
get
/health
Health
get
/api/whoami
Whoami
get
/api/openapi.yaml
Openapi Yaml
Webhooks
Webhooks
8
Identities
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Connect Identity Imessage Number
post
/api/v1/identities/{agent_handle}/imessage_number
Oct 21, 2026
43519e4ad6d8
Revision changes
info
added the optional property
line_role
to the response with the
201
status