API REST

Count read from the public specification: 120 operations across 91 paths. Limit: 50 requests per second and 2,500 per minute.

120 operations

• GET/api/v1/analytics/agents-performanceAgent performance metrics
• GET/api/v1/analytics/conversation-analysis/{id}Conversation analysis (sentiment, intent, summary)
• GET/api/v1/analytics/conversationsConversation sentiment analytics
• GET/api/v1/analytics/dashboardDashboard KPIs (conversations, contacts, deals, CSAT)
• GET/api/v1/analytics/financial/settingsValue metrics settings
• PUT/api/v1/analytics/financial/settingsUpdate value metrics settings
• GET/api/v1/analytics/lead-score/{contactId}Lead score for contact
• GET/api/v1/callsList call history
• GET/api/v1/calls/{id}Call detail
• GET/api/v1/calls/{id}/analysisCall transcription and sentiment
• GET/api/v1/calls/{id}/notesList call notes
• POST/api/v1/calls/{id}/notesAdd note to call
• GET/api/v1/telephony/configTenant telephony configuration
• GET/api/v1/telephony/providersList telephony providers
• GET/api/v1/campaignsList campaigns
• POST/api/v1/campaignsCreate campaign (draft)
• DELETE/api/v1/campaigns/{id}Delete campaign (draft only)
• GET/api/v1/campaigns/{id}Campaign detail
• PUT/api/v1/campaigns/{id}Update campaign (draft only)
• POST/api/v1/campaigns/{id}/cancelCancel scheduled campaign
• GET/api/v1/campaigns/{id}/metricsCampaign delivery metrics
• GET/api/v1/campaigns/{id}/recipientsList campaign recipients
• POST/api/v1/campaigns/{id}/recipientsAdd recipients to campaign
• GET/api/v1/playbooksList playbooks
• GET/api/v1/playbooks/{id}Playbook detail
• GET/api/v1/channel/listList channels
• GET/api/v1/chatbotsList chatbot flows
• GET/api/v1/chatbots/{id}Chatbot flow detail
• GET/api/v1/chats/{id}Get chat by ID
• GET/api/v1/chats/{id}/attributesList conversation attributes
• POST/api/v1/chats/{id}/attributesUpsert conversation attributes
• GET/api/v1/chats/{id}/attributes/{key}Get conversation attribute by key
• GET/api/v1/chats/{id}/classificationGet conversation classification (sentiment, intent)
• POST/api/v1/chats/{id}/finalizeFinalize a single chat
• GET/api/v1/chats/{id}/messagesList messages of a chat (cursor-paginated)
• GET/api/v1/chats/{id}/notesList conversation notes
• POST/api/v1/chats/{id}/notesAdd note to conversation
• DELETE/api/v1/chats/{id}/notes/{noteId}Delete conversation note
• DELETE/api/v1/chats/{id}/pinUnpin a conversation
• POST/api/v1/chats/{id}/pinPin a conversation
• POST/api/v1/chats/{id}/transferTransfer chat to agent or team
• POST/api/v1/chats/countCount conversations by filters
• POST/api/v1/chats/create-newOpen a new chat with a contact and optionally send first message
• POST/api/v1/chats/finalizeBulk finalize conversations
• GET/api/v1/chats/listList chats
• POST/api/v1/chats/list-liteLightweight conversation list
• POST/api/v1/chats/messages/schedulerSchedule a message
• DELETE/api/v1/chats/messages/scheduler/{scheduleId}Cancel scheduled message
• GET/api/v1/chats/messages/scheduler/{scheduleId}Get scheduled message by ID
• POST/api/v1/chats/messages/scheduler/listList scheduled messages
• GET/api/v1/chats/pinnedList pinned conversations
• POST/api/v1/chats/send-textSend a WhatsApp text message
• GET/api/v1/contactsList contacts
• POST/api/v1/contactsCreate contact
• GET/api/v1/contacts/{id}Get contact by ID
• GET/api/v1/contacts/{id}/attributesList contact attributes
• POST/api/v1/contacts/{id}/attributesUpsert contact attributes
• GET/api/v1/contacts/{id}/attributes/{key}Get contact attribute by key
• GET/api/v1/contacts/{id}/tagsList contact tags
• PUT/api/v1/contacts/{id}/tagsReplace all tags on contact
• PUT/api/v1/contacts/{id}/tags/addAdd tags to contact (incremental)
• PUT/api/v1/contacts/{id}/tags/removeRemove tags from contact
• GET/api/v1/contacts/number/{number}Lookup contact by phone number
• GET/api/v1/csat/configGet CSAT configuration
• PUT/api/v1/csat/configUpdate CSAT configuration
• GET/api/v1/csat/metricsAggregated CSAT metrics
• GET/api/v1/csat/metrics/by-agentCSAT metrics grouped by agent
• GET/api/v1/csat/metrics/trendCSAT daily trend (last 90 days)
• GET/api/v1/csat/ratingsList CSAT ratings
• GET/api/v1/dealsList deals
• POST/api/v1/dealsCreate deal
• DELETE/api/v1/deals/{id}Delete deal
• GET/api/v1/deals/{id}Deal detail with stage history
• PUT/api/v1/deals/{id}Update deal
• POST/api/v1/deals/{id}/closeClose deal as won or lost
• PUT/api/v1/deals/{id}/custom-propertiesSet custom property values on deal
• GET/api/v1/deals/{id}/historyDeal stage movement history
• POST/api/v1/deals/{id}/moveMove deal to stage (records history)
• GET/api/v1/deals/custom-propertiesList custom property definitions
• POST/api/v1/deals/custom-propertiesCreate custom property
• GET/api/v1/deals/pipelinesList pipelines with stages
• POST/api/v1/messagesSend message (unified)
• DELETE/api/v1/messages/{id}Soft-delete a message
• GET/api/v1/pipelinesList pipelines
• POST/api/v1/pipelinesCreate pipeline
• DELETE/api/v1/pipelines/{id}Delete pipeline (fails if has deals)
• GET/api/v1/pipelines/{id}Pipeline detail with stages
• PUT/api/v1/pipelines/{id}Update pipeline
• GET/api/v1/pipelines/{id}/stagesList stages of a pipeline
• POST/api/v1/pipelines/{id}/stagesCreate stage
• DELETE/api/v1/pipelines/{pipelineId}/stages/{stageId}Delete stage (fails if has deals)
• PUT/api/v1/pipelines/{pipelineId}/stages/{stageId}Update stage
• GET/api/v1/scriptsList automation scripts
• DELETE/api/v1/scripts/{id}Delete script
• GET/api/v1/scripts/{id}Script detail (includes code)
• GET/api/v1/scripts/eventsList available trigger event types
• DELETE/api/v1/scripts/scheduler/{id}Cancel scheduled script
• POST/api/v1/scripts/scheduler/listList script executions
• GET/api/v1/check-is-service-timeCheck if current time is within business hours
• GET/api/v1/service-time-rulesList business hours rules
• GET/api/v1/general-settingsGet company settings
• POST/api/v1/general-settingsUpdate company settings
• GET/healthHealth check
• GET/api/v1/tagsList workspace tags
• GET/api/v1/teamsList teams
• POST/api/v1/teamsCreate team
• GET/api/v1/teams/{id}Team detail with members
• PUT/api/v1/teams/{id}Update team
• POST/api/v1/teams/{id}/membersAdd member to team
• DELETE/api/v1/teams/{id}/members/{memberId}Remove member from team
• GET/api/v1/teams/{id}/permissionsList team permissions
• PUT/api/v1/teams/{id}/permissionsBulk upsert team permissions
• GET/api/v1/quick-answersList quick replies
• GET/api/v1/quick-answers/{id}Quick reply detail
• GET/api/v1/templatesList WhatsApp templates
• GET/api/v1/templates/{id}WhatsApp template detail
• GET/api/v1/usersList users
• GET/api/v1/users/{id}User detail
• PUT/api/v1/users/{id}Update user profile
• GET/api/v1/users/meCurrent user profile

Copy of the specification as of 2026-10-16. We re-check before each release.