All 165 operations across 19 resources. Required parameters are marked with *. Search ops paginate with limit + page and return Laravel-paginator responses.
Group jumps: Agent Group · Facebook Utility Template · Flow · Flow AI Hub · Flow Bot Field · Flow Conversation · Flow Custom Events · Flow Segment · Flow Tag · Flow User Field · Integration · OpenAI · Sending · Subscriber · Team Label · Ticket List · User · WhatsApp Template · Workspace
| Operation | Method | Path | Label | Params |
|---|---|---|---|---|
teamViewAgentGroup |
GET | /team/agent-group/{id} |
View Agent Group | id* |
teamAgentGroups |
GET | /team/agent-groups |
List Agent Groups | limit page name |
teamCreateAgentGroup |
POST | /team/create-agent-group |
Create Agent Group | name* image assign_method online_first only_view_assigned_to_me |
teamUpdateAgentGroupUsers |
POST | /team/update-agent-group-users/{id} |
Set Agent Group Members | id* members* |
teamUpdateAgentGroup |
PUT | /team/update-agent-group/{id} |
Update Agent Group | id* name* image assign_method online_first only_view_assigned_to_me |
teamDeleteAgentGroup |
DELETE | /team/delete-agent-group/{id} |
Delete Agent Group | id* |
| Operation | Method | Path | Label | Params |
|---|---|---|---|---|
CreateFacebookUtilityMessageTemplate |
POST | /facebook-utility-message-template/create |
Create Facebook Utility Message Template | name* language* components* |
listFacebookUtilityMessageTemplates |
POST | /facebook-utility-message-template/list |
List Facebook Utility Message Templates | limit page name |
SyncFacebookUtilityMessageTemplates |
POST | /facebook-utility-message-template/sync |
Sync Facebook Utility Message Templates | no params |
DeleteFacebookUtilityMessageTemplate |
DELETE | /facebook-utility-message-template/delete |
Delete Facebook Utility Message Template | name* |
| Operation | Method | Path | Label | Params |
|---|---|---|---|---|
listSubflows |
GET | /flow/subflows |
List Sub-flows | limit page name |
deleteSubflow |
DELETE | /flow/delete-sub-flow |
Delete Sub-flow | sub_flow_ns* |
getBotUsersCount |
GET | /flow/bot-users-count |
Get Bot Users Count | no params |
listTemplateInstalls |
GET | /flow/template-installs |
List Template Installs | limit page |
setDefaultStartFlow |
POST | /flow/set-default-start-flow |
Set Default Start Flow | sub_flow_ns* |
setWebChatDefaultStartFlow |
POST | /flow/set-web-chat-widget-default-start-flow |
Set Web-Chat Default Start Flow | sub_flow_ns* |
listFlowAgents |
GET | /flow/agents |
List Agents | limit page name role |
listInboundWebhooks |
GET | /flow/inbound-webhooks |
List Inbound Webhooks | limit page name |
listChatWidgets |
GET | /flow/chat-button-widgets |
List Chat Widgets | limit page code |
| Operation | Method | Path | Label | Params |
|---|---|---|---|---|
listAiAgents |
GET | /flow/ai-agents |
List AI Agents | limit page ai_agent_ns ai_provider name |
updateAiAgentProvider |
POST | /flow/update-ai-agent-provider |
Update AI Agent Provider | ai_agent_ns* ai_provider ai_model max_tokens |
listAiTasks |
GET | /flow/ai-tasks |
List AI Tasks | limit page ai_task_ns ai_provider name |
updateAiTaskProvider |
POST | /flow/update-ai-task-provider |
Update AI Task Provider | ai_task_ns* ai_provider ai_model max_tokens |
setDefaultAiProvider |
POST | /flow/settings/set-default-ai-provider |
Set Default AI Provider | ai_provider* ai_model |
setAudioTranscription |
POST | /flow/settings/set-audio-transcription |
Set Audio Transcription Model | stt_model* |
| Operation | Method | Path | Label | Params |
|---|---|---|---|---|
listBotFields |
GET | /flow/bot-fields |
List Bot Fields | limit page name |
createBotField |
POST | /flow/create-bot-field |
Create Bot Field | name* type default_value |
setBotField |
PUT | /flow/set-bot-field |
Set Bot Field | var_ns* value |
setBotFieldByName |
PUT | /flow/set-bot-field-by-name |
Set Bot Field by Name | name* value |
setBotFields |
PUT | /flow/set-bot-fields |
Set Multiple Bot Fields | data* |
setBotFieldsByName |
PUT | /flow/set-bot-fields-by-name |
Set Multiple Bot Fields by Name | data* |
deleteBotField |
DELETE | /flow/delete-bot-field |
Delete Bot Field | var_ns* |
deleteBotFieldByName |
DELETE | /flow/delete-bot-field-by-name |
Delete Bot Field by Name | name* |
| Operation | Method | Path | Label | Params |
|---|---|---|---|---|
listClosedConversations |
GET | /flow/conversations/data |
List Closed Conversations | user_ns start_time end_time start_id limit |
listAgentActivityLog |
GET | /flow/agent-activity-log/data |
List Agent Activity Log | user_ns agent_id conv_id action source_type start_time end_time limit |
getChatMessages |
GET | /subscriber/chat-messages |
Get Chat Messages | user_ns user_id include_bot include_note include_system msg_type start_time end_time limit |
getMessagesByIds |
POST | /subscriber/chat-messages-by-mids |
Get Messages by IDs | mids* |
moveChatTo |
POST | /subscriber/move-chat-to |
Move Chat To | user_ns* status* |
assignAgent |
POST | /subscriber/assign-agent |
Assign Agent | user_ns* agent_id* |
assignAgentGroup |
POST | /subscriber/assign-agent-group |
Assign Agent Group | user_ns* agent_group_id* |
unassignAgent |
POST | /subscriber/unassign-agent |
Unassign Agent | user_ns* |
pauseBot |
POST | /subscriber/pause-bot |
Pause Bot | user_ns* minutes |
resumeBot |
POST | /subscriber/resume-bot |
Resume Bot | user_ns* |
| Operation | Method | Path | Label | Params |
|---|---|---|---|---|
listCustomEvents |
GET | /flow/custom-events |
List Custom Events | limit page name |
getCustomEventsSummary |
GET | /flow/custom-events/summary |
Get Custom Events Summary | event_ns* range |
getCustomEventsData |
GET | /flow/custom-events/data |
Get Custom Events Data | event_ns* start_time end_time start_id limit |
logCustomEvent |
POST | /subscriber/log-custom-event |
Log Custom Event | user_ns* event_name* text_value price_value number_value |
| Operation | Method | Path | Label | Params |
|---|---|---|---|---|
listSegments |
GET | /flow/segments |
List Segments | limit page name |
| Operation | Method | Path | Label | Params |
|---|---|---|---|---|
listTags |
GET | /flow/tags |
List Tags | limit page name |
createTag |
POST | /flow/create-tag |
Create Tag | name* |
deleteTag |
DELETE | /flow/delete-tag |
Delete Tag | tag_ns* |
deleteTagByName |
DELETE | /flow/delete-tag-by-name |
Delete Tag by Name | name* |
| Operation | Method | Path | Label | Params |
|---|---|---|---|---|
listUserFields |
GET | /flow/user-fields |
List User Fields | limit page name |
createUserField |
POST | /flow/create-user-field |
Create User Field | name* type display_type |
updateUserField |
POST | /flow/update-user-field |
Update User Field | var_ns* name display_type |
deleteUserField |
DELETE | /flow/delete-user-field |
Delete User Field | var_ns* |
deleteUserFieldByName |
DELETE | /flow/delete-user-field-by-name |
Delete User Field by Name | name* |
| Operation | Method | Path | Label | Params |
|---|---|---|---|---|
listInstalledMiniApps |
GET | /installed-mini-app/list |
List Installed Mini-Apps | limit page title |
getDropiData |
GET | /integration/dropi |
Get Dropi Integration Config | no params |
getMetaConversionsApiData |
GET | /integration/meta-conversions-api |
Get Meta Conversions API Config | no params |
getOpenAiData |
GET | /integration/openai |
Get OpenAI Integration Config | no params |
getS3StorageData |
GET | /integration/s3storage |
Get S3 Storage Integration Config | no params |
getShopifyData |
GET | /integration/shopify |
Get Shopify Integration Config | no params |
getWoocommerceData |
GET | /integration/woocommerce |
Get WooCommerce Integration Config | no params |
updateMiniAppApiKey |
POST | /installed-mini-app/update-api-key/{app_id} |
Update Mini-App API Key | app_id* api_key |
updateDropiData |
POST | /integration/dropi |
Update Dropi Integration Config | url* api_key* |
updateMetaConversionsApiData |
POST | /integration/meta-conversions-api |
Update Meta Conversions API Config | token* dataset_id* |
updateOpenAiData |
POST | /integration/openai |
Update OpenAI Integration Config | api_key* org_id |
updateS3StorageData |
POST | /integration/s3storage |
Update S3 Storage Integration Config | url* api_key* secret* bucket* region |
updateShopifyData |
POST | /integration/shopify |
Update Shopify Integration Config | url* api_key* token* wait_time |
updateWoocommerceData |
POST | /integration/woocommerce |
Update WooCommerce Integration Config | url* api_key* token* |
clearDropiData |
DELETE | /integration/dropi |
Clear Dropi Integration Config | no params |
clearMetaConversionsApiData |
DELETE | /integration/meta-conversions-api |
Clear Meta Conversions API Config | no params |
clearOpenAiData |
DELETE | /integration/openai |
Clear OpenAI Integration Config | no params |
clearS3StorageData |
DELETE | /integration/s3storage |
Clear S3 Storage Integration Config | no params |
clearShopifyData |
DELETE | /integration/shopify |
Clear Shopify Integration Config | no params |
clearWoocommerceData |
DELETE | /integration/woocommerce |
Clear WooCommerce Integration Config | no params |
| Operation | Method | Path | Label | Params |
|---|---|---|---|---|
OpenAiEmbeddingList |
GET | /openai-embeddings |
List OpenAI Embeddings | limit page heading text |
OpenAiEmbeddingGetInfo |
GET | /openai-embeddings/{id}/get-info |
Get OpenAI Embedding Info | id* |
OpenAiEmbeddingCreate |
POST | /openai-embeddings/create |
Create OpenAI Embedding | type heading* text* |
OpenAiEmbeddingGenerate |
POST | /openai-embeddings/generate |
Regenerate OpenAI Embeddings | no params |
OpenAiEmbeddingImport |
POST | /openai-embeddings/import |
Import OpenAI Embeddings | rows* |
OpenAiEmbeddingUpdate |
PUT | /openai-embeddings/{id}/update |
Update OpenAI Embedding | id* type heading text |
OpenAiEmbeddingDelete |
DELETE | /openai-embeddings/{id}/delete |
Delete OpenAI Embedding | id* |
| Operation | Method | Path | Label | Params |
|---|---|---|---|---|
sendMainFlow |
POST | /subscriber/send-main-flow |
Send Main Flow | user_ns* |
sendSubFlow |
POST | /subscriber/send-sub-flow |
Send Sub-flow | user_ns* sub_flow_ns* |
sendSubFlowByName |
POST | /subscriber/send-sub-flow-by-flow-name |
Send Sub-flow by Name | user_ns* flow_name* |
sendSubFlowByUserId |
POST | /subscriber/send-sub-flow-by-user-id |
Send Sub-flow by Channel User ID | user_id* sub_flow_ns* |
sendText |
POST | /subscriber/send-text |
Send Text Message | user_ns* content* |
sendSms |
POST | /subscriber/send-sms |
Send SMS | user_ns* content* |
sendEmail |
POST | /subscriber/send-email |
Send Email | user_ns* subject* content* |
sendNode |
POST | /subscriber/send-node |
Send Node | user_ns* node_ns* |
sendWhatsAppTemplate |
POST | /subscriber/send-whatsapp-template |
Send WhatsApp Template | user_ns* template_namespace template_name* template_language* template_params |
sendWhatsAppTemplateByUserId |
POST | /subscriber/send-whatsapp-template-by-user-id |
Send WhatsApp Template by Channel User ID | user_id* template_namespace template_name* template_language* template_params create_if_not_found contact |
sendWhatsAppTemplateDynamic |
POST | /subscriber/send-whatsapp-template |
Send WhatsApp Template by Subscriber NS (Dynamic Fields) | user_ns* template_name* template_params |
sendWhatsAppTemplateByUserIdDynamic |
POST | /subscriber/send-whatsapp-template-by-user-id |
Send WhatsApp Template by Channel User ID (Dynamic Fields) | user_id* template_name* template_params create_if_not_found contact |
sendContent |
POST | /subscriber/send-content |
Send Content | user_ns* data* |
broadcastToList |
POST | /subscriber/broadcast |
Broadcast to List | user_ns_list* sub_flow_ns type scheduled_time max_per_minute |
broadcastByUserId |
POST | /subscriber/broadcast-by-user-id |
Broadcast by Channel User IDs | user_id_list* sub_flow_ns type scheduled_time max_per_minute |
broadcastWhatsAppTemplateByUserId |
POST | /subscriber/broadcast-whatsapp-template-by-user-id |
Broadcast WhatsApp Template by Channel User IDs | user_id_list* template_namespace template_name* template_language* template_params scheduled_time max_per_minute |
broadcastByTag |
POST | /subscriber/broadcast-by-tag |
Broadcast by Tag | tags* sub_flow_ns exclude_tags name scheduled_time max_per_minute type message_tag user_fields |
broadcastWhatsAppTemplateByTag |
POST | /subscriber/broadcast-whatsapp-template-by-tag |
Broadcast WhatsApp Template by Tag | tags* template_namespace template_name* template_language* template_params exclude_tags scheduled_time max_per_minute |
broadcastBySegment |
POST | /subscriber/broadcast-by-segment |
Broadcast by Segment | segment_ns* sub_flow_ns scheduled_time max_per_minute type message_tag bot_fields |
| Operation | Method | Path | Label | Params |
|---|---|---|---|---|
searchSubscribers |
GET | /subscribers |
Search Subscribers | limit page name phone email is_channel is_opt_in_email is_opt_in_sms is_interacted_in_last_24h is_bot_interacted_in_last_24h is_last_message_in_last_24h tag_ns label_id event_ns user_field_ns user_field_value |
getSubscriberInfo |
GET | /subscriber/get-info |
Get Subscriber Info | user_ns* |
getSubscriberInfoByUserId |
GET | /subscriber/get-info-by-user-id |
Get Subscriber Info by Channel User ID | user_id* |
createSubscriber |
POST | /subscriber/create |
Create Subscriber | phone email first_name last_name name gender image |
createSubscribersBulk |
POST | /subscriber/create-many |
Create Subscribers (Bulk) | users* |
updateSubscriber |
PUT | /subscriber/update |
Update Subscriber | user_ns* first_name last_name name phone email gender image |
deleteSubscriber |
DELETE | /subscriber/delete |
Delete Subscriber | user_ns* |
addSubscriberTag |
POST | /subscriber/add-tag |
Add Tag to Subscriber | user_ns* tag_ns* |
addSubscriberTagByName |
POST | /subscriber/add-tag-by-name |
Add Tag to Subscriber by Name | user_ns* tag_name* |
addSubscriberTags |
POST | /subscriber/add-tags |
Add Multiple Tags to Subscriber | user_ns* data* |
addSubscriberTagsByName |
POST | /subscriber/add-tags-by-name |
Add Multiple Tags to Subscriber by Name | user_ns* data* |
removeSubscriberTag |
DELETE | /subscriber/remove-tag |
Remove Tag from Subscriber | user_ns* tag_ns* |
removeSubscriberTagByName |
DELETE | /subscriber/remove-tag-by-name |
Remove Tag from Subscriber by Name | user_ns* tag_name* |
removeSubscriberTags |
DELETE | /subscriber/remove-tags |
Remove Multiple Tags from Subscriber | user_ns* data* |
removeSubscriberTagsByName |
DELETE | /subscriber/remove-tags-by-name |
Remove Multiple Tags from Subscriber by Name | user_ns* data* |
addSubscriberLabels |
POST | /subscriber/add-labels-by-name |
Add Labels to Subscriber | user_ns* data* |
removeSubscriberLabels |
DELETE | /subscriber/remove-labels-by-name |
Remove Labels from Subscriber | user_ns* data* |
setUserField |
PUT | /subscriber/set-user-field |
Set User Field | user_ns* var_ns* value |
setUserFieldByName |
PUT | /subscriber/set-user-field-by-name |
Set User Field by Name | user_ns* field_name* value |
setUserFields |
PUT | /subscriber/set-user-fields |
Set Multiple User Fields | user_ns* data* |
setUserFieldsByName |
PUT | /subscriber/set-user-fields-by-name |
Set Multiple User Fields by Name | user_ns* data* |
clearUserField |
DELETE | /subscriber/clear-user-field |
Clear User Field | user_ns* var_ns* |
clearUserFieldByName |
DELETE | /subscriber/clear-user-field-by-name |
Clear User Field by Name | user_ns* field_name* |
clearUserFields |
DELETE | /subscriber/clear-user-fields |
Clear Multiple User Fields | user_ns* data* |
clearUserFieldsByName |
DELETE | /subscriber/clear-user-fields-by-name |
Clear Multiple User Fields by Name | user_ns* data* |
subscribeToBot |
POST | /subscriber/subscribe-to-bot |
Subscribe to Bot | user_ns* |
unsubscribeFromBot |
DELETE | /subscriber/unsubscribe-from-bot |
Unsubscribe from Bot | user_ns* |
optInSms |
POST | /subscriber/opt-in-sms |
Opt-in SMS | user_ns* |
optOutSms |
DELETE | /subscriber/opt-out-sms |
Opt-out SMS | user_ns* |
optInEmail |
POST | /subscriber/opt-in-email |
Opt-in Email | user_ns* |
optOutEmail |
DELETE | /subscriber/opt-out-email |
Opt-out Email | user_ns* |
triggerAppEvent |
POST | /subscriber/app-trigger |
Trigger App Event | user_ns* trigger_name* context |
| Operation | Method | Path | Label | Params |
|---|---|---|---|---|
teamLabels |
GET | /team/labels |
List Labels | limit page name |
teamCreateLabel |
POST | /team/create-label |
Create Label | name* |
teamDeleteLabel |
DELETE | /team/delete-label |
Delete Label | id* |
teamDeleteLabelByName |
DELETE | /team/delete-label-by-name |
Delete Label By Name | name* |
| Operation | Method | Path | Label | Params |
|---|---|---|---|---|
teamTicketLists |
GET | /team/ticket-lists |
List Ticket Lists | limit page name |
teamTicketListFields |
GET | /team/ticket-lists/{listId}/fields |
List Ticket List Fields | listId* |
teamTicketListItems |
GET | /team/ticket-lists/{listId}/items |
List Ticket List Items | listId* limit page title flow_ns user_ns |
teamTicketListLogData |
GET | /team/ticket-lists/{listId}/log-data |
List Ticket List Change Log | listId* start_time end_time flow_ns user_ns list_item_id column_name limit |
teamCreateTicketListItem |
POST | /team/ticket-lists/{listId}/create |
Create Ticket List Item | listId* title* user_ns* description assignee text1 text2 text3 text4 text5 select1 select2 select3 select4 select5 number1 number2 rating1 rating2 date1 date2 |
teamUpdateTicketListItem |
PUT | /team/ticket-lists/{listId}/update/{listItemId} |
Update Ticket List Item | listId* listItemId* title description assignee text1 text2 text3 text4 text5 select1 select2 select3 select4 select5 number1 number2 rating1 rating2 date1 date2 |
teamDeleteTicketListItem |
DELETE | /team/ticket-lists/{listId}/delete/{listItemId} |
Delete Ticket List Item | listId* listItemId* |
| Operation | Method | Path | Label | Params |
|---|---|---|---|---|
UserInfo |
GET | /me |
Get Current User Info | no params |
RecentNotifications |
GET | /notifications/recent |
List Recent Notifications & Announcements | no params |
MarkAnnouncementAsRead |
POST | /announcements/read |
Mark Announcement As Read | no params |
MarkNotificationAsRead |
POST | /notifications/read |
Mark Notification As Read | notification_id |
userChangePassword |
PUT | /user/change-password |
Change Password | current_password* password* password_confirmation* |
| Operation | Method | Path | Label | Params |
|---|---|---|---|---|
listWhatsAppTemplates |
POST | /whatsapp-template/list |
List WhatsApp Templates | limit page name |
createWhatsAppTemplate |
POST | /whatsapp-template/create |
Create WhatsApp Template | name language category components |
deleteWhatsAppTemplate |
DELETE | /whatsapp-template/delete |
Delete WhatsApp Template | name* |
syncWhatsAppTemplates |
POST | /whatsapp-template/sync |
Sync WhatsApp Templates | no params |
| Operation | Method | Path | Label | Params |
|---|---|---|---|---|
AnalyticsFlowAgentSummary |
GET | /flow-agent-summary |
Get Flow Agent Summary | range flow_ns |
AnalyticsFlowSummary |
GET | /flow-summary |
Get Flow Summary | range flow_ns |
teamBotUsers |
GET | /team-bot-users |
List Bot Users | limit page name phone email is_channel is_opt_in_email is_opt_in_sms is_interacted_in_last_24h is_bot_interacted_in_last_24h is_last_message_in_last_24h |
workspaceBots |
GET | /team-flows |
List Bots | limit page name type |
workspaceInfo |
GET | /team-info |
Get Workspace Info | no params |
workspaceMembers |
GET | /team-members |
List Members | limit page name role |
workspaceSettingsChannels |
GET | /workspace-settings/channels |
Get Workspace Channels Settings | no params |
workspaceSettingsLiveChatSidebar |
GET | /workspace-settings/live-chat-sidebar |
Get Live-Chat Sidebar Settings | no params |
workspaceSettingsChannelsUpdate |
POST | /workspace-settings/update-channels |
Update Workspace Channels Settings | chat facebook instagram telegram slack whatsapp whatsapp_cloud wechat voice sms rcs line viber vk intercom jivochat chatwoot tiktok |
workspaceSettingsLiveChatSidebarUpdate |
POST | /workspace-settings/update-live-chat-sidebar |
Update Live-Chat Sidebar Settings | data |
