/

Docs
History
Schema
Generate

Filter operations

A2A21

A2A Invitations7

Agent Signup7

API Keys6

Billing18

Brand7

Campaign8

Contact Access3

Contact Communication Policies3

Contact Correspondence1

Contact Memory6

Contact Rules12

Contacts13

Domains11

Drafts10

Hosted Call Agent17

Identities45

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}/accessGet Identity Contact Access
patch/api/v1/identities/{agent_handle}/contacts/{contact_id}/accessPatch Identity Contact Access
get/api/v1/identities/selfGet Current Identity
get/api/v1/identities/{agent_handle}/channel-statusGet 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-policiesList Contact Communication Policies
get/api/v1/identities/{agent_handle}/contact-permissionsList Identity Contact Permissions
get/api/v1/identities/{agent_handle}/contacts/{contact_id}/permissionsGet Identity Contact Permissions
patch/api/v1/identities/{agent_handle}/contacts/{contact_id}/permissionsPatch Identity Contact Permissions
get/api/v1/identities/{agent_handle}/companionGet Companion
patch/api/v1/identities/{agent_handle}/companionPatch Companion
get/api/v1/identities/{agent_handle}/companion/conversationsList Companion Conversations
get/api/v1/identities/{agent_handle}/companion/activations/{activation_id}/messagesGet Companion History
get/api/v1/identities/{agent_handle}/slack-contact-rulesList Slack Contact Rules
post/api/v1/identities/{agent_handle}/slack-contact-rulesCreate 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-affiliationGet Affiliation
put/api/v1/identities/{agent_handle}/domain-affiliationSet Affiliation
delete/api/v1/identities/{agent_handle}/domain-affiliationRemove Affiliation
get/api/v1/identities/{agent_handle}/avatarGet Identity Avatar
put/api/v1/identities/{agent_handle}/avatarUpload Identity Avatar
delete/api/v1/identities/{agent_handle}/avatarDelete Identity Avatar
get/api/v1/identities/{agent_handle}/avatar-metadataGet Identity Avatar Metadata
post/api/v1/identities/{agent_handle}/avatar/stagedSet Identity Avatar From Staged Media
delete/api/v1/identities/{agent_handle}/phone_numberRelease Identity Phone Number
post/api/v1/identities/{agent_handle}/imessage_numberConnect Identity Imessage Number
delete/api/v1/identities/{agent_handle}/imessage_numberDisconnect Identity Imessage Number
get/api/v1/identities/{agent_handle}/mail-contact-rulesList Mail Contact Rules
post/api/v1/identities/{agent_handle}/mail-contact-rulesCreate 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-rulesList Phone Contact Rules
post/api/v1/identities/{agent_handle}/phone-contact-rulesCreate 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-keyGet Identity Signing Key Status
post/api/v1/identities/{agent_handle}/signing-keyCreate Or Rotate Identity Signing Key

Identity Access3

iMessage21

iMessage Contact Rules6

iMessage Router9

Imports6

Mailboxes4

Message Sends1

Messages13

Note Access3

Notes5

Organization Domains5

Phone Calls12

Phone Numbers5

Phone Transcripts2

Privacy1

Resource Links1

Search2

Signing Keys2

Slack55

SMS Opt-Ins4

Text Messages10

Threads9

Tunnels4

Vault4

Vault Keys3

Vault Secret Access3

Vault Secrets5

Webhooks11

WhatsApp14

get/healthHealth
get/api/whoamiWhoami
get/api/openapi.yamlOpenapi Yaml

Webhooks

Webhooks8

Identities

Changes to Set Affiliation

put/api/v1/identities/{agent_handle}/domain-affiliation

Oct 3, 20267e1cc96d89d7 Revision changes
- info
  endpoint added