API v1 reference
Every endpoint of the Zavu API v1: messages, senders, contacts, agents, phone numbers and more.
Base URL https://api.zavu.dev. Authenticate every request with Authorization: Bearer YOUR_API_KEY. The full spec is at /docs/openapi.json.
10DLC
- GETList 10DLC brands
/v1/10dlc/brands - POSTCreate 10DLC brand
/v1/10dlc/brands - GETList 10DLC use cases
/v1/10dlc/brands/use-cases - GETGet 10DLC brand
/v1/10dlc/brands/{brandId} - PATCHUpdate 10DLC brand
/v1/10dlc/brands/{brandId} - DELETEDelete 10DLC brand
/v1/10dlc/brands/{brandId} - POSTSubmit 10DLC brand for review
/v1/10dlc/brands/{brandId}/submit - POSTSync 10DLC brand status
/v1/10dlc/brands/{brandId}/sync - GETList 10DLC campaigns
/v1/10dlc/campaigns - POSTCreate 10DLC campaign
/v1/10dlc/campaigns - GETGet 10DLC campaign
/v1/10dlc/campaigns/{campaignId} - PATCHUpdate 10DLC campaign
/v1/10dlc/campaigns/{campaignId} - DELETEDelete 10DLC campaign
/v1/10dlc/campaigns/{campaignId} - POSTSubmit 10DLC campaign for review
/v1/10dlc/campaigns/{campaignId}/submit - POSTSync 10DLC campaign status
/v1/10dlc/campaigns/{campaignId}/sync - GETList campaign phone number assignments
/v1/10dlc/campaigns/{campaignId}/phone-numbers - POSTAssign phone number to campaign
/v1/10dlc/campaigns/{campaignId}/phone-numbers - DELETEUnassign phone number from campaign
/v1/10dlc/campaigns/{campaignId}/phone-numbers/{assignmentId}
Account
Agent Flows
- GETList flows
/v1/senders/{senderId}/agent/flows - POSTCreate flow
/v1/senders/{senderId}/agent/flows - GETGet flow
/v1/senders/{senderId}/agent/flows/{flowId} - PATCHUpdate flow
/v1/senders/{senderId}/agent/flows/{flowId} - DELETEDelete flow
/v1/senders/{senderId}/agent/flows/{flowId} - POSTDuplicate flow
/v1/senders/{senderId}/agent/flows/{flowId}/duplicate
Agent Knowledge Bases
- GETList knowledge bases
/v1/senders/{senderId}/agent/knowledge-bases - POSTCreate knowledge base
/v1/senders/{senderId}/agent/knowledge-bases - GETGet knowledge base
/v1/senders/{senderId}/agent/knowledge-bases/{kbId} - PATCHUpdate knowledge base
/v1/senders/{senderId}/agent/knowledge-bases/{kbId} - DELETEDelete knowledge base
/v1/senders/{senderId}/agent/knowledge-bases/{kbId} - GETList documents
/v1/senders/{senderId}/agent/knowledge-bases/{kbId}/documents - POSTCreate document
/v1/senders/{senderId}/agent/knowledge-bases/{kbId}/documents - GETGet document
/v1/senders/{senderId}/agent/knowledge-bases/{kbId}/documents/{docId} - PATCHUpdate document
/v1/senders/{senderId}/agent/knowledge-bases/{kbId}/documents/{docId} - DELETEDelete document
/v1/senders/{senderId}/agent/knowledge-bases/{kbId}/documents/{docId}
Agent Tools
- GETList tools
/v1/senders/{senderId}/agent/tools - POSTCreate tool
/v1/senders/{senderId}/agent/tools - GETGet tool
/v1/senders/{senderId}/agent/tools/{toolId} - PATCHUpdate tool
/v1/senders/{senderId}/agent/tools/{toolId} - DELETEDelete tool
/v1/senders/{senderId}/agent/tools/{toolId} - POSTTest tool
/v1/senders/{senderId}/agent/tools/{toolId}/test - GETList tool test runs
/v1/senders/{senderId}/agent/tools/{toolId}/test-runs - POSTRotate a tool's webhook secret
/v1/senders/{senderId}/agent/tools/{toolId}/webhook/secret
Agents
- GETGet agent
/v1/senders/{senderId}/agent - POSTCreate agent
/v1/senders/{senderId}/agent - PATCHUpdate agent
/v1/senders/{senderId}/agent - DELETEDelete agent
/v1/senders/{senderId}/agent - GETGet agent statistics
/v1/senders/{senderId}/agent/stats - GETList agent executions
/v1/senders/{senderId}/agent/executions - GETGet a single agent execution
/v1/senders/{senderId}/agent/executions/{executionId} - GETList factory agents
/v1/agent-templates - GETGet a factory agent
/v1/agent-templates/{templateId} - GETList agents
/v1/agents - POSTCreate a standalone agent
/v1/agents - GETGet an agent
/v1/agents/{agentId} - PATCHUpdate an agent
/v1/agents/{agentId} - DELETEDelete an agent
/v1/agents/{agentId} - POSTTest an agent
/v1/agents/{agentId}/test - POSTConnect a sender to an agent
/v1/agents/{agentId}/senders - DELETEDisconnect a sender from an agent
/v1/agents/{agentId}/senders/{senderId} - GETList agent voices
/v1/agents/voices
Balance
Broadcasts
- GETList broadcasts
/v1/broadcasts - POSTCreate broadcast
/v1/broadcasts - GETGet broadcast
/v1/broadcasts/{broadcastId} - PATCHUpdate broadcast
/v1/broadcasts/{broadcastId} - DELETEDelete broadcast
/v1/broadcasts/{broadcastId} - GETList broadcast contacts
/v1/broadcasts/{broadcastId}/contacts - POSTAdd contacts to broadcast
/v1/broadcasts/{broadcastId}/contacts - DELETERemove contact from broadcast
/v1/broadcasts/{broadcastId}/contacts/{contactId} - POSTSend broadcast
/v1/broadcasts/{broadcastId}/send - PATCHReschedule broadcast
/v1/broadcasts/{broadcastId}/schedule - POSTCancel broadcast
/v1/broadcasts/{broadcastId}/cancel - POSTRetry broadcast review
/v1/broadcasts/{broadcastId}/retry-review - POSTEscalate to manual review
/v1/broadcasts/{broadcastId}/escalate - GETGet broadcast progress
/v1/broadcasts/{broadcastId}/progress
Contacts
- GETList contacts
/v1/contacts - POSTCreate contact
/v1/contacts - GETGet contact
/v1/contacts/{contactId} - PATCHUpdate contact
/v1/contacts/{contactId} - DELETEDelete contact
/v1/contacts/{contactId} - GETGet contact by phone number
/v1/contacts/phone/{phoneNumber} - POSTAdd channel to contact
/v1/contacts/{contactId}/channels - PATCHUpdate channel
/v1/contacts/{contactId}/channels/{channelId} - DELETERemove channel from contact
/v1/contacts/{contactId}/channels/{channelId} - POSTSet channel as primary
/v1/contacts/{contactId}/channels/{channelId}/primary - POSTMerge contacts
/v1/contacts/{contactId}/merge
Conversations
Email Domains
Functions
- GETList function event types
/v1/functions/event-types - GETList function triggers
/v1/functions/{functionId}/triggers - POSTCreate function triggers
/v1/functions/{functionId}/triggers - PATCHEnable or disable a trigger
/v1/functions/triggers/{triggerId} - DELETEDelete a trigger
/v1/functions/triggers/{triggerId} - GETList function deployments
/v1/functions/{functionId}/deployments - POSTRoll back to a previous deployment
/v1/functions/{functionId}/rollback - POSTCreate function
/v1/functions - GETGet function
/v1/functions/{functionId} - PATCHUpdate function draft
/v1/functions/{functionId} - DELETEDelete function
/v1/functions/{functionId} - POSTDeploy function
/v1/functions/{functionId}/deploy - GETGet deployment
/v1/functions/deployments/{deploymentId} - GETList function secrets
/v1/functions/{functionId}/secrets - PUTSet function secret
/v1/functions/{functionId}/secrets/{key} - DELETEUnset function secret
/v1/functions/{functionId}/secrets/{key} - GETGet the linked repository
/v1/functions/{functionId}/git-link - POSTLink a GitHub repository
/v1/functions/{functionId}/git-link - PATCHUpdate the linked repository
/v1/functions/{functionId}/git-link - DELETEUnlink the repository
/v1/functions/{functionId}/git-link - POSTDeploy the linked branch now
/v1/functions/{functionId}/git-link/deploy - GETTail function logs
/v1/functions/{functionId}/logs
Introspect
Invitations
- GETList invitations
/v1/invitations - POSTCreate invitation
/v1/invitations - GETGet project webhook
/v1/invitations/webhook - POSTConfigure project webhook
/v1/invitations/webhook - PATCHUpdate project webhook
/v1/invitations/webhook - DELETERemove project webhook
/v1/invitations/webhook - GETGet invitation
/v1/invitations/{invitationId} - POSTCancel invitation
/v1/invitations/{invitationId}/cancel
Memory
- GETList collections
/v1/memory/collections - POSTCreate a collection
/v1/memory/collections - GETGet a collection
/v1/memory/collections/{collection} - PATCHUpdate a collection
/v1/memory/collections/{collection} - DELETEDelete a collection
/v1/memory/collections/{collection} - GETList items
/v1/memory/collections/{collection}/items - POSTWrite items in bulk
/v1/memory/collections/{collection}/items/batch - GETGet an item
/v1/memory/collections/{collection}/items/{key} - PUTWrite an item
/v1/memory/collections/{collection}/items/{key} - DELETEDelete an item
/v1/memory/collections/{collection}/items/{key} - POSTQuery items by field
/v1/memory/collections/{collection}/query - GETList facts
/v1/memory - POSTRemember a fact
/v1/memory - DELETEForget an entire scope
/v1/memory - POSTRecall facts by meaning
/v1/memory/search - GETGet Memory usage
/v1/memory/usage - GETGet a fact
/v1/memory/{memoryId} - DELETEForget a fact
/v1/memory/{memoryId}
Messages
Phone numbers
- GETGet regulatory requirements
/v1/phone-numbers/requirements - GETSearch available phone numbers
/v1/phone-numbers/available - GETList phone numbers
/v1/phone-numbers - POSTPurchase a phone number
/v1/phone-numbers - GETGet phone number
/v1/phone-numbers/{phoneNumberId} - PATCHUpdate phone number
/v1/phone-numbers/{phoneNumberId} - DELETERelease phone number
/v1/phone-numbers/{phoneNumberId}
Regulatory
- GETList addresses
/v1/addresses - POSTCreate address
/v1/addresses - GETGet address
/v1/addresses/{addressId} - DELETEDelete address
/v1/addresses/{addressId} - GETList documents
/v1/documents - POSTCreate document
/v1/documents - POSTGet document upload URL
/v1/documents/upload-url - GETGet document
/v1/documents/{documentId} - DELETEDelete document
/v1/documents/{documentId}
Senders
- GETList senders
/v1/senders - POSTCreate sender
/v1/senders - GETGet sender
/v1/senders/{senderId} - PATCHUpdate sender
/v1/senders/{senderId} - DELETEDelete sender
/v1/senders/{senderId} - POSTRegenerate webhook secret
/v1/senders/{senderId}/webhook/secret - POSTActivate a sender channel
/v1/senders/{senderId}/channels/{channel}/activate - POSTDeactivate a sender channel
/v1/senders/{senderId}/channels/{channel}/deactivate - GETGet WhatsApp Business profile
/v1/senders/{senderId}/profile - PATCHUpdate WhatsApp Business profile
/v1/senders/{senderId}/profile - POSTUpload WhatsApp Business profile picture
/v1/senders/{senderId}/profile/picture - POSTConnect Telegram
/v1/senders/{senderId}/telegram - DELETEDisconnect Telegram
/v1/senders/{senderId}/telegram
Sub-Accounts
- GETList sub-accounts
/v1/sub-accounts - POSTCreate sub-account
/v1/sub-accounts - GETGet sub-account
/v1/sub-accounts/{id} - PATCHUpdate sub-account
/v1/sub-accounts/{id} - DELETEDeactivate sub-account
/v1/sub-accounts/{id} - GETGet sub-account spending
/v1/sub-accounts/{id}/balance - GETList sub-account API keys
/v1/sub-accounts/{id}/api-keys - POSTCreate sub-account API key
/v1/sub-accounts/{id}/api-keys - DELETERevoke sub-account API key
/v1/sub-accounts/{id}/api-keys/{keyId}