Reference

Jump to resource: Agent Group · Facebook Utility Template · Flow · Flow AI Hub · Flow Bot Field · Flow Closing Note · Flow Conversation · Flow Custom Events · Flow Segment · Flow Shortcut · Flow Tag · Flow User Field · Integration · OpenAI · Sending · Shop Business Hours · Shop Discount Code · Shop Location · Shop Order · Shop Product · Shop Product Tag · Shop Product Type · Shop Product Variant · Shop Product Vendor · Subscriber · Subscriber Cart · Team Label · Template · Ticket List · User · WhatsApp Template · Workspace

Agent Group 6

Operation	Method	Path	Label	Parameters
teamViewAgentGroup	GET	/team/agent-group/{id}	View Agent Group	id integer required Agent Group Id
teamAgentGroups	GET	/team/agent-groups	List Agent Groups	limit integer Number of items in the response page integer Page number, between 1 and 100 name text Search for agent group name
teamCreateAgentGroup	POST	/team/create-agent-group	Create Agent Group	name text required image text assign_method text random,least_assigned,round_robin online_first integer Default (0), Online First (1), Online Only (2) only_view_assigned_to_me integer All Conversations (0), Only conversations assigned to me (1)
teamUpdateAgentGroupUsers	POST	/team/update-agent-group-users/{id}	Set Agent Group Members	id integer required Agent Group Id members array<text> required
teamUpdateAgentGroup	PUT	/team/update-agent-group/{id}	Update Agent Group	id integer required Agent Group Id name text required image text assign_method text random,least_assigned,round_robin online_first integer Default (0), Online First (1), Online Only (2) only_view_assigned_to_me integer All Conversations (0), Only conversations assigned to me (1)
teamDeleteAgentGroup	DELETE	/team/delete-agent-group/{id}	Delete Agent Group	id integer required Agent Group Id

Facebook Utility Template 4

Operation	Method	Path	Label	Parameters
CreateFacebookUtilityMessageTemplate	POST	/facebook-utility-message-template/create	Create Facebook Utility Message Template	name text required Template name language text required components array<text> required Facebook utility template components
listFacebookUtilityMessageTemplates	POST	/facebook-utility-message-template/list	List Facebook Utility Message Templates	limit integer Number of items in the response page integer Page number, between 1 and 100 name text Search for template name
SyncFacebookUtilityMessageTemplates	POST	/facebook-utility-message-template/sync	Sync Facebook Utility Message Templates	no parameters
DeleteFacebookUtilityMessageTemplate	DELETE	/facebook-utility-message-template/delete	Delete Facebook Utility Message Template	name text required

Flow 9

Operation	Method	Path	Label	Parameters
listSubflows	GET	/flow/subflows	List Sub-flows	limit integer default 50 page integer default 1 name text
deleteSubflow	DELETE	/flow/delete-sub-flow	Delete Sub-flow	sub_flow_ns select · live list required
getBotUsersCount	GET	/flow/bot-users-count	Get Bot Users Count	no parameters
listTemplateInstalls	GET	/flow/template-installs	List Template Installs	limit integer default 50 page integer default 1
setDefaultStartFlow	POST	/flow/set-default-start-flow	Set Default Start Flow	sub_flow_ns select · live list required
setWebChatDefaultStartFlow	POST	/flow/set-web-chat-widget-default-start-flow	Set Web-Chat Default Start Flow	sub_flow_ns select · live list required
listFlowAgents	GET	/flow/agents	List Agents	limit integer default 50 page integer default 1 name text role text
listInboundWebhooks	GET	/flow/inbound-webhooks	List Inbound Webhooks	limit integer default 50 page integer default 1 name text
listChatWidgets	GET	/flow/chat-button-widgets	List Chat Widgets	limit integer default 50 page integer default 1 code text

Flow AI Hub 9

Operation	Method	Path	Label	Parameters
listAiAgents	GET	/flow/ai-agents	List AI Agents	limit integer default 50 page integer default 1 ai_agent_ns select · live list ai_provider select(openai | openai-responses | deepseek | xai | xai-responses | claude | gemini | groq) name text
updateAiAgentProvider	POST	/flow/update-ai-agent-provider	Update AI Agent Provider	ai_agent_ns select · live list required ai_provider select(openai | openai-responses | deepseek | xai | xai-responses | claude | gemini | groq) ai_model text max_tokens integer
listAiTasks	GET	/flow/ai-tasks	List AI Tasks	limit integer default 50 page integer default 1 ai_task_ns select · live list ai_provider select(openai | openai-responses | deepseek | xai | xai-responses | claude | gemini | groq) name text
updateAiTaskProvider	POST	/flow/update-ai-task-provider	Update AI Task Provider	ai_task_ns select · live list required ai_provider select(openai | openai-responses | deepseek | xai | xai-responses | claude | gemini | groq) ai_model text max_tokens integer
setDefaultAiProvider	POST	/flow/settings/set-default-ai-provider	Set Default AI Provider	ai_provider select(openai | openai-responses | deepseek | xai | xai-responses | claude | gemini | groq) required ai_model text
setAudioTranscription	POST	/flow/settings/set-audio-transcription	Set Audio Transcription Model	stt_model text required
getAiAgentInfo	POST	/flow/ai-agent-info	Get AI Agent Info	ai_agent_ns select · live list required
getAiTaskInfo	POST	/flow/ai-task-info	Get AI Task Info	ai_task_ns select · live list required
getDefaultAiProvider	GET	/flow/settings/get-default-ai-provider	Get Default AI Provider	no parameters

Flow Bot Field 8

Operation	Method	Path	Label	Parameters
listBotFields	GET	/flow/bot-fields	List Bot Fields	limit integer default 50 page integer default 1 name text
createBotField	POST	/flow/create-bot-field	Create Bot Field	name text required type text default_value text
setBotField	PUT	/flow/set-bot-field	Set Bot Field	var_ns select · live list required value text
setBotFieldByName	PUT	/flow/set-bot-field-by-name	Set Bot Field by Name	name text required value text
setBotFields	PUT	/flow/set-bot-fields	Set Multiple Bot Fields	data array<{ var_ns, value }> required
setBotFieldsByName	PUT	/flow/set-bot-fields-by-name	Set Multiple Bot Fields by Name	data array<{ name, value }> required
deleteBotField	DELETE	/flow/delete-bot-field	Delete Bot Field	var_ns select · live list required
deleteBotFieldByName	DELETE	/flow/delete-bot-field-by-name	Delete Bot Field by Name	name text required

Flow Closing Note 5

Operation	Method	Path	Label	Parameters
listClosingNotes	GET	/flow/closing-notes	List Closing Notes	limit integer default 50 page integer default 1 name text
getClosingNote	GET	/flow/closing-notes/{id}	Get Closing Note	id integer required
createClosingNote	POST	/flow/create-closing-note	Create Closing Note	name text required description text require_summary boolean require_attachment boolean
updateClosingNote	PUT	/flow/update-closing-note	Update Closing Note	id integer required name text description text require_summary boolean require_attachment boolean
deleteClosingNote	DELETE	/flow/delete-closing-note	Delete Closing Note	id integer required

Flow Conversation 10

Operation	Method	Path	Label	Parameters
listClosedConversations	GET	/flow/conversations/data	List Closed Conversations	user_ns text start_time integer end_time integer start_id text limit integer default 100
listAgentActivityLog	GET	/flow/agent-activity-log/data	List Agent Activity Log	user_ns text agent_id text conv_id text action text source_type text start_time integer end_time integer limit integer default 100
getChatMessages	GET	/subscriber/chat-messages	Get Chat Messages	user_ns text user_id text include_bot boolean include_note boolean include_system boolean msg_type text start_time integer end_time integer limit integer default 100
getMessagesByIds	POST	/subscriber/chat-messages-by-mids	Get Messages by IDs	mids array<text> required
moveChatTo	POST	/subscriber/move-chat-to	Move Chat To	user_ns text required status select(open | in_progress | done) required
assignAgent	POST	/subscriber/assign-agent	Assign Agent	user_ns text required agent_id select · live list required
assignAgentGroup	POST	/subscriber/assign-agent-group	Assign Agent Group	user_ns text required agent_group_id select · live list required
unassignAgent	POST	/subscriber/unassign-agent	Unassign Agent	user_ns text required
pauseBot	POST	/subscriber/pause-bot	Pause Bot	user_ns text required minutes integer
resumeBot	POST	/subscriber/resume-bot	Resume Bot	user_ns text required

Flow Custom Events 4

Operation	Method	Path	Label	Parameters
listCustomEvents	GET	/flow/custom-events	List Custom Events	limit integer default 50 page integer default 1 name text
getCustomEventsSummary	GET	/flow/custom-events/summary	Get Custom Events Summary	event_ns select · live list required range text
getCustomEventsData	GET	/flow/custom-events/data	Get Custom Events Data	event_ns select · live list required start_time integer end_time integer start_id text limit integer default 100
logCustomEvent	POST	/subscriber/log-custom-event	Log Custom Event	user_ns text required event_name text required text_value text price_value number number_value number

Flow Segment 1

Operation	Method	Path	Label	Parameters
listSegments	GET	/flow/segments	List Segments	limit integer default 50 page integer default 1 name text

Flow Shortcut 5

Operation	Method	Path	Label	Parameters
listShortcuts	GET	/flow/shortcuts	List Shortcuts	limit integer default 50 page integer default 1 name text
getShortcut	GET	/flow/shortcuts/{id}	Get Shortcut	id integer required
createShortcut	POST	/flow/create-shortcut	Create Shortcut	name text required value text required The text the shortcut expands to.
updateShortcut	PUT	/flow/update-shortcut	Update Shortcut	id integer required name text value text
deleteShortcut	DELETE	/flow/delete-shortcut	Delete Shortcut	id integer required

Flow Tag 4

Operation	Method	Path	Label	Parameters
listTags	GET	/flow/tags	List Tags	limit integer default 50 page integer default 1 name text
createTag	POST	/flow/create-tag	Create Tag	name text required
deleteTag	DELETE	/flow/delete-tag	Delete Tag	tag_ns select · live list required
deleteTagByName	DELETE	/flow/delete-tag-by-name	Delete Tag by Name	name text required

Flow User Field 5

Operation	Method	Path	Label	Parameters
listUserFields	GET	/flow/user-fields	List User Fields	limit integer default 50 page integer default 1 name text
createUserField	POST	/flow/create-user-field	Create User Field	name text required type text display_type text
updateUserField	POST	/flow/update-user-field	Update User Field	var_ns select · live list required name text display_type text
deleteUserField	DELETE	/flow/delete-user-field	Delete User Field	var_ns select · live list required
deleteUserFieldByName	DELETE	/flow/delete-user-field-by-name	Delete User Field by Name	name text required

Integration 29

Operation	Method	Path	Label	Parameters
listInstalledMiniApps	GET	/installed-mini-app/list	List Installed Mini-Apps	limit integer Number of items in the response page integer Page number, between 1 and 100 title text Search for app title
getDropiData	GET	/integration/dropi	Get Dropi Integration Config	no parameters
getMetaConversionsApiData	GET	/integration/meta-conversions-api	Get Meta Conversions API Config	no parameters
getOpenAiData	GET	/integration/openai	Get OpenAI Integration Config	no parameters
getS3StorageData	GET	/integration/s3storage	Get S3 Storage Integration Config	no parameters
getShopifyData	GET	/integration/shopify	Get Shopify Integration Config	no parameters
getWoocommerceData	GET	/integration/woocommerce	Get WooCommerce Integration Config	no parameters
updateMiniAppApiKey	POST	/installed-mini-app/update-api-key/{app_id}	Update Mini-App API Key	app_id integer required Mini App Id api_key text the property name is defined in the mini app
updateDropiData	POST	/integration/dropi	Update Dropi Integration Config	url text required API URL api_key text required API key
updateMetaConversionsApiData	POST	/integration/meta-conversions-api	Update Meta Conversions API Config	token text required Access Token dataset_id text required Dataset ID
updateOpenAiData	POST	/integration/openai	Update OpenAI Integration Config	api_key text required API Key org_id text Organization Id
updateS3StorageData	POST	/integration/s3storage	Update S3 Storage Integration Config	url text required Endpoint api_key text required Key secret text required Secret bucket text required Bucket Name region text Region
updateShopifyData	POST	/integration/shopify	Update Shopify Integration Config	url text required MyShopify Domain api_key text required API key or Client ID token text required Access Token or Client Secret wait_time integer Abandoned cart wait time, default is 30 minutes
updateWoocommerceData	POST	/integration/woocommerce	Update WooCommerce Integration Config	url text required Store URL api_key text required API consumer key token text required API consumer secret
clearDropiData	DELETE	/integration/dropi	Clear Dropi Integration Config	no parameters
clearMetaConversionsApiData	DELETE	/integration/meta-conversions-api	Clear Meta Conversions API Config	no parameters
clearOpenAiData	DELETE	/integration/openai	Clear OpenAI Integration Config	no parameters
clearS3StorageData	DELETE	/integration/s3storage	Clear S3 Storage Integration Config	no parameters
clearShopifyData	DELETE	/integration/shopify	Clear Shopify Integration Config	no parameters
clearWoocommerceData	DELETE	/integration/woocommerce	Clear WooCommerce Integration Config	no parameters
getClaudeData	GET	/integration/claude	Get Claude AI Integration Config	no parameters
updateClaudeData	POST	/integration/calude	Update Claude AI Integration Config	api_key password required
clearClaudeData	DELETE	/integration/calude	Clear Claude AI Integration Config	no parameters
getXaiData	GET	/integration/xai	Get xAI Integration Config	no parameters
updateXaiData	POST	/integration/xai	Update xAI Integration Config	api_key password required
clearXaiData	DELETE	/integration/xai	Clear xAI Integration Config	no parameters
getAinventedData	GET	/integration/ainvented	Get Ainvented Integration Config	no parameters
updateAinventedData	POST	/integration/ainvented	Update Ainvented Integration Config	api_key password required
clearAinventedData	DELETE	/integration/ainvented	Clear Ainvented Integration Config	no parameters

OpenAI 7

Operation	Method	Path	Label	Parameters
OpenAiEmbeddingList	GET	/openai-embeddings	List OpenAI Embeddings	limit integer Number of items in the response page integer Page number, between 1 and 100 heading text Search for heading text text Search for text
OpenAiEmbeddingGetInfo	GET	/openai-embeddings/{id}/get-info	Get OpenAI Embedding Info	id integer required Id
OpenAiEmbeddingCreate	POST	/openai-embeddings/create	Create OpenAI Embedding	type text heading text required text text required
OpenAiEmbeddingGenerate	POST	/openai-embeddings/generate	Regenerate OpenAI Embeddings	no parameters
OpenAiEmbeddingImport	POST	/openai-embeddings/import	Import OpenAI Embeddings	rows array<text> required
OpenAiEmbeddingUpdate	PUT	/openai-embeddings/{id}/update	Update OpenAI Embedding	id integer required Id type text heading text text text
OpenAiEmbeddingDelete	DELETE	/openai-embeddings/{id}/delete	Delete OpenAI Embedding	id integer required Id

Sending 23

Operation	Method	Path	Label	Parameters
sendMainFlow	POST	/subscriber/send-main-flow	Send Main Flow	user_ns text required
sendSubFlow	POST	/subscriber/send-sub-flow	Send Sub-flow	user_ns text required sub_flow_ns select · live list required
sendSubFlowByName	POST	/subscriber/send-sub-flow-by-flow-name	Send Sub-flow by Name	user_ns text required flow_name text required
sendSubFlowByUserId	POST	/subscriber/send-sub-flow-by-user-id	Send Sub-flow by Channel User ID	user_id text required sub_flow_ns select · live list required
sendText	POST	/subscriber/send-text	Send Text Message	user_ns text required content text required
sendSms	POST	/subscriber/send-sms	Send SMS	user_ns text required content text required
sendEmail	POST	/subscriber/send-email	Send Email	user_ns text required subject text required content text required
sendNode	POST	/subscriber/send-node	Send Node	user_ns text required node_ns text required
sendWhatsAppTemplate	POST	/subscriber/send-whatsapp-template	Send WhatsApp Template	user_ns text required template_namespace text WhatsApp template namespace. template_name select · live list required Pick an approved template by name. template_language text required default he BCP-47 language code (e.g. he, en_US). template_params array<{ key, value }> Add one row per template variable. Use the "Map" toggle to paste/reference an array of {key,value} from a previous module.
sendWhatsAppTemplateByUserId	POST	/subscriber/send-whatsapp-template-by-user-id	Send WhatsApp Template by Channel User ID	user_id text required template_namespace text WhatsApp template namespace. template_name select · live list required Pick an approved template by name. template_language text required default he BCP-47 language code (e.g. he, en_US). template_params array<{ key, value }> Add one row per template variable. Use the "Map" toggle to paste/reference an array of {key,value} from a previous module. create_if_not_found boolean contact text Optional contact profile when creating subscriber.
sendWhatsAppTemplateDynamic	POST	/subscriber/send-whatsapp-template	Send WhatsApp Template by Subscriber NS (Dynamic Fields)	user_ns text required template_name select · live list required Pick a template — namespace, language, and the list of expected variables auto-fill below. template_params array<{ key, value }> Add one row per template variable. Use the "Map" toggle to paste/reference an array of {key,value} from a previous module.
sendWhatsAppTemplateByUserIdDynamic	POST	/subscriber/send-whatsapp-template-by-user-id	Send WhatsApp Template by Channel User ID (Dynamic Fields)	user_id text required template_name select · live list required Pick a template — namespace, language, and the list of expected variables auto-fill below. template_params array<{ key, value }> Add one row per template variable. Use the "Map" toggle to paste/reference an array of {key,value} from a previous module. create_if_not_found boolean contact text Optional contact profile when creating subscriber.
sendContent	POST	/subscriber/send-content	Send Content	user_ns text required data text required
broadcastToList	POST	/subscriber/broadcast	Broadcast to List	user_ns_list array<text> required sub_flow_ns select · live list type select(EMAIL | SMS | WHATSAPP_TEMPLATE | FACEBOOK_NOTIFICATION) scheduled_time integer max_per_minute integer
broadcastByUserId	POST	/subscriber/broadcast-by-user-id	Broadcast by Channel User IDs	user_id_list array<text> required sub_flow_ns select · live list type select(EMAIL | SMS | WHATSAPP_TEMPLATE | FACEBOOK_NOTIFICATION) scheduled_time integer max_per_minute integer
broadcastWhatsAppTemplateByUserId	POST	/subscriber/broadcast-whatsapp-template-by-user-id	Broadcast WhatsApp Template by Channel User IDs	user_id_list array<text> required template_namespace text WhatsApp template namespace. template_name select · live list required Pick an approved template by name. template_language text required default he BCP-47 language code (e.g. he, en_US). template_params array<{ key, value }> Add one row per template variable. Use the "Map" toggle to paste/reference an array of {key,value} from a previous module. scheduled_time integer max_per_minute integer
broadcastByTag	POST	/subscriber/broadcast-by-tag	Broadcast by Tag	tags array<text> required sub_flow_ns select · live list exclude_tags array<text> name text scheduled_time integer max_per_minute integer type select(EMAIL | SMS | WHATSAPP_TEMPLATE | FACEBOOK_NOTIFICATION) message_tag text user_fields text
broadcastWhatsAppTemplateByTag	POST	/subscriber/broadcast-whatsapp-template-by-tag	Broadcast WhatsApp Template by Tag	tags array<text> required template_namespace text WhatsApp template namespace. template_name select · live list required Pick an approved template by name. template_language text required default he BCP-47 language code (e.g. he, en_US). template_params array<{ key, value }> Add one row per template variable. Use the "Map" toggle to paste/reference an array of {key,value} from a previous module. exclude_tags array<text> scheduled_time integer max_per_minute integer
broadcastBySegment	POST	/subscriber/broadcast-by-segment	Broadcast by Segment	segment_ns select · live list required sub_flow_ns select · live list scheduled_time integer max_per_minute integer type select(EMAIL | SMS | WHATSAPP_TEMPLATE | FACEBOOK_NOTIFICATION) message_tag text bot_fields text
broadcastFacebookUtilityMessageTemplateByTag	POST	/subscriber/broadcast-facebook-utility-message-template-by-tag	Broadcast Facebook Utility Template by Tag	tags array<text> required template_name text required template_language text required default he BCP-47 language code (e.g. he, en_US). template_params array<{ key, value }> Leave empty to use the template's default values. exclude_tags array<text> scheduled_time integer max_per_minute integer
sendFacebookUtilityMessageTemplate	POST	/subscriber/send-facebook-utility-message-template	Send Facebook Utility Template	user_ns text required template_name text required template_language text required default he BCP-47 language code (e.g. he, en_US). use_default_values boolean When enabled the template's stored default values are used and Parameters is ignored. template_params array<{ key, value }> One row per template variable. Ignored when 'Use template default values' is on.
sendFacebookUtilityMessageTemplateByUserId	POST	/subscriber/send-facebook-utility-message-template-by-user-id	Send Facebook Utility Template by User ID	user_id text required template_name text required template_language text required default he BCP-47 language code (e.g. he, en_US). use_default_values boolean When enabled the template's stored default values are used and Parameters is ignored. template_params array<{ key, value }> One row per template variable. Ignored when 'Use template default values' is on.
broadcastFacebookUtilityMessageTemplateByUserId	POST	/subscriber/broadcast-facebook-utility-message-template-by-user-id	Broadcast Facebook Utility Template by User IDs	user_id_list text required Comma-separated channel user IDs, up to 200. template_name text required template_language text required default he BCP-47 language code (e.g. he, en_US). use_default_values boolean When enabled the template's stored default values are used and Parameters is ignored. template_params array<{ key, value }> One row per template variable. Ignored when 'Use template default values' is on. scheduled_time integer max_per_minute integer

Shop Business Hours 2

Operation	Method	Path	Label	Parameters
getBusinessHours	GET	/shop/business-hours/info	Get Business Hours	no parameters
updateBusinessHours	PUT	/shop/business-hours/update	Update Business Hours	data array<{ id, name, option, start, end, start_2, end_2 }> required

Shop Discount Code 7

Operation	Method	Path	Label	Parameters
listDiscountCodes	GET	/shop/discount-codes	List Discount Codes	limit integer default 50 page integer default 1 code text
getDiscountCodeInfo	GET	/shop/discount-codes/{codeId}/get-info	Get Discount Code Info	codeId integer required
getDiscountCodeByCode	GET	/shop/discount-codes/get-info-by-code	Get Discount Code by Code	code text required
createDiscountCode	POST	/shop/discount-codes/create	Create Discount Code	code text required type select(percentage | amount | free_shipping) required discount_percentage integer discount_amount number once_per_order boolean min_require text none, min_price or min_qty min_price number min_qty integer has_usage_limit boolean max_usage_count integer one_per_customer boolean start_time text required Y-m-d H:i:s end_time text required Y-m-d H:i:s
updateDiscountCode	PUT	/shop/discount-codes/{codeId}/update	Update Discount Code	codeId integer required code text type select(percentage | amount | free_shipping) discount_percentage integer discount_amount number once_per_order boolean min_require text none, min_price or min_qty min_price number min_qty integer has_usage_limit boolean max_usage_count integer one_per_customer boolean start_time text Y-m-d H:i:s end_time text Y-m-d H:i:s
deleteDiscountCode	DELETE	/shop/discount-codes/{codeId}/delete	Delete Discount Code	codeId integer required
deleteDiscountCodeByCode	DELETE	/shop/discount-codes/delete-by-code	Delete Discount Code by Code	code text required

Shop Location 5

Operation	Method	Path	Label	Parameters
listLocations	GET	/shop/locations	List Locations	limit integer default 50 page integer default 1 name text
getLocationInfo	GET	/shop/locations/{locationId}/get-info	Get Location Info	locationId integer required
createLocation	POST	/shop/locations/create	Create Location	name text required address text required note text lat number required lng number required
updateLocation	PUT	/shop/locations/{locationId}/update	Update Location	locationId integer required name text address text note text lat number lng number
deleteLocation	DELETE	/shop/locations/{locationId}/delete	Delete Location	locationId integer required

Shop Order 4

Operation	Method	Path	Label	Parameters
listOrders	GET	/shop/orders	List Orders	user_ns text limit integer default 50 page integer default 1
getOrderInfo	GET	/shop/orders/{orderId}/get-info	Get Order Info	orderId integer required
createOrder	POST	/shop/orders/create	Create Order	user_ns text required status select(paid | ordered | processing | shipped | completed | cancelled | refunded) shipping_method text payment_method text reference_no text note text address text suburb text state text postcode text country text tracking_no text items array<{ variant_id, qty }>
updateOrder	PUT	/shop/orders/{orderId}/update	Update Order	orderId integer required status select(paid | ordered | processing | shipped | completed | cancelled | refunded) shipping_method text payment_method text reference_no text note text address text suburb text state text postcode text country text tracking_no text items array<{ variant_id, qty }>

Shop Product 5

Operation	Method	Path	Label	Parameters
listProducts	GET	/shop/products	List Products	limit integer default 50 page integer default 1 name text product_type_id integer vendor_id integer
getProductInfo	GET	/shop/products/{productId}/get-info	Get Product Info	productId select · live list required
createProduct	POST	/shop/products/create	Create Product	name text required description text image text note text status select(active | draft | archived) type text vendor text tags array<text> use_variant boolean price integer compare_price integer sku text barcode text track_stock boolean allow_no_stock_sell boolean qty integer variant_1_name text variant_2_name text variants array<{ image, variant_1_value, variant_2_value, price, compare_price, taxable, sku, barcode, track_stock, allow_no_stock_sell, qty }> Only used when 'Use variants' is on.
updateProduct	PUT	/shop/products/{productId}/update	Update Product	productId select · live list required name text required description text image text note text status select(active | draft | archived) type text vendor text tags array<text>
deleteProduct	DELETE	/shop/products/{productId}/delete	Delete Product	productId select · live list required

Shop Product Tag 5

Operation	Method	Path	Label	Parameters
listProductTags	GET	/shop/product-tags	List Product Tags	limit integer default 50 page integer default 1 name text
getProductTagInfo	GET	/shop/product-tags/{tagId}/get-info	Get Product Tag Info	tagId integer required
createProductTag	POST	/shop/product-tags/create	Create Product Tag	name text required
updateProductTag	PUT	/shop/product-tags/{tagId}/update	Update Product Tag	tagId integer required name text required
deleteProductTag	DELETE	/shop/product-tags/{tagId}/delete	Delete Product Tag	tagId integer required

Shop Product Type 5

Operation	Method	Path	Label	Parameters
listProductTypes	GET	/shop/product-types	List Product Types	limit integer default 50 page integer default 1 name text
getProductTypeInfo	GET	/shop/product-types/{typeId}/get-info	Get Product Type Info	typeId integer required
createProductType	POST	/shop/product-types/create	Create Product Type	name text required
updateProductType	PUT	/shop/product-types/{typeId}/update	Update Product Type	typeId integer required name text required
deleteProductType	DELETE	/shop/product-types/{typeId}/delete	Delete Product Type	typeId integer required

Shop Product Variant 5

Operation	Method	Path	Label	Parameters
listProductVariants	GET	/shop/products/{productId}/variants	List Product Variants	productId select · live list required limit integer default 50 page integer default 1
getProductVariantInfo	GET	/shop/products/{productId}/variants/{variantId}/get-info	Get Product Variant Info	productId select · live list required variantId integer required
createProductVariant	POST	/shop/products/{productId}/variants/create	Create Product Variant	productId select · live list required image text variant_1_value text variant_2_value text price integer compare_price integer taxable boolean sku text barcode text track_stock boolean allow_no_stock_sell boolean qty integer
updateProductVariant	PUT	/shop/products/{productId}/variants/{variantId}/update	Update Product Variant	productId select · live list required variantId integer required image text variant_1_value text variant_2_value text price integer compare_price integer taxable boolean sku text barcode text track_stock boolean allow_no_stock_sell boolean qty integer
deleteProductVariant	DELETE	/shop/products/{productId}/variants/{variantId}/delete	Delete Product Variant	productId select · live list required variantId integer required

Shop Product Vendor 5

Operation	Method	Path	Label	Parameters
listProductVendors	GET	/shop/product-vendors	List Product Vendors	limit integer default 50 page integer default 1 name text
getProductVendorInfo	GET	/shop/product-vendors/{vendorId}/get-info	Get Product Vendor Info	vendorId integer required
createProductVendor	POST	/shop/product-vendors/create	Create Product Vendor	name text required
updateProductVendor	PUT	/shop/product-vendors/{vendorId}/update	Update Product Vendor	vendorId integer required name text required
deleteProductVendor	DELETE	/shop/product-vendors/{vendorId}/delete	Delete Product Vendor	vendorId integer required

Subscriber 32

Operation	Method	Path	Label	Parameters
searchSubscribers	GET	/subscribers	Search Subscribers	limit integer default 50 page integer default 1 name text phone text email text is_channel boolean is_opt_in_email boolean is_opt_in_sms boolean is_interacted_in_last_24h boolean is_bot_interacted_in_last_24h boolean is_last_message_in_last_24h boolean tag_ns select · live list label_id text event_ns text user_field_ns select · live list user_field_value text
getSubscriberInfo	GET	/subscriber/get-info	Get Subscriber Info	user_ns text required
getSubscriberInfoByUserId	GET	/subscriber/get-info-by-user-id	Get Subscriber Info by Channel User ID	user_id text required
createSubscriber	POST	/subscriber/create	Create Subscriber	phone text email text first_name text last_name text name text gender text image text
createSubscribersBulk	POST	/subscriber/create-many	Create Subscribers (Bulk)	users array<{ phone, email, first_name, last_name, name, gender, image }> required
updateSubscriber	PUT	/subscriber/update	Update Subscriber	user_ns text required first_name text last_name text name text phone text email text gender text image text
deleteSubscriber	DELETE	/subscriber/delete	Delete Subscriber	user_ns text required
addSubscriberTag	POST	/subscriber/add-tag	Add Tag to Subscriber	user_ns text required tag_ns select · live list required
addSubscriberTagByName	POST	/subscriber/add-tag-by-name	Add Tag to Subscriber by Name	user_ns text required tag_name text required
addSubscriberTags	POST	/subscriber/add-tags	Add Multiple Tags to Subscriber	user_ns text required data array<{ tag_ns }> required
addSubscriberTagsByName	POST	/subscriber/add-tags-by-name	Add Multiple Tags to Subscriber by Name	user_ns text required data array<{ tag_name }> required
removeSubscriberTag	DELETE	/subscriber/remove-tag	Remove Tag from Subscriber	user_ns text required tag_ns select · live list required
removeSubscriberTagByName	DELETE	/subscriber/remove-tag-by-name	Remove Tag from Subscriber by Name	user_ns text required tag_name text required
removeSubscriberTags	DELETE	/subscriber/remove-tags	Remove Multiple Tags from Subscriber	user_ns text required data array<{ tag_ns }> required
removeSubscriberTagsByName	DELETE	/subscriber/remove-tags-by-name	Remove Multiple Tags from Subscriber by Name	user_ns text required data array<{ tag_name }> required
addSubscriberLabels	POST	/subscriber/add-labels-by-name	Add Labels to Subscriber	user_ns text required data array<{ label_name }> required
removeSubscriberLabels	DELETE	/subscriber/remove-labels-by-name	Remove Labels from Subscriber	user_ns text required data array<{ label_name }> required
setUserField	PUT	/subscriber/set-user-field	Set User Field	user_ns text required var_ns select · live list required value text
setUserFieldByName	PUT	/subscriber/set-user-field-by-name	Set User Field by Name	user_ns text required field_name text required value text
setUserFields	PUT	/subscriber/set-user-fields	Set Multiple User Fields	user_ns text required data array<{ var_ns, value }> required
setUserFieldsByName	PUT	/subscriber/set-user-fields-by-name	Set Multiple User Fields by Name	user_ns text required data array<{ field_name, value }> required
clearUserField	DELETE	/subscriber/clear-user-field	Clear User Field	user_ns text required var_ns select · live list required
clearUserFieldByName	DELETE	/subscriber/clear-user-field-by-name	Clear User Field by Name	user_ns text required field_name text required
clearUserFields	DELETE	/subscriber/clear-user-fields	Clear Multiple User Fields	user_ns text required data array<text> required
clearUserFieldsByName	DELETE	/subscriber/clear-user-fields-by-name	Clear Multiple User Fields by Name	user_ns text required data array<text> required
subscribeToBot	POST	/subscriber/subscribe-to-bot	Subscribe to Bot	user_ns text required
unsubscribeFromBot	DELETE	/subscriber/unsubscribe-from-bot	Unsubscribe from Bot	user_ns text required
optInSms	POST	/subscriber/opt-in-sms	Opt-in SMS	user_ns text required
optOutSms	DELETE	/subscriber/opt-out-sms	Opt-out SMS	user_ns text required
optInEmail	POST	/subscriber/opt-in-email	Opt-in Email	user_ns text required
optOutEmail	DELETE	/subscriber/opt-out-email	Opt-out Email	user_ns text required
triggerAppEvent	POST	/subscriber/app-trigger	Trigger App Event	user_ns text required trigger_name text required context text

Subscriber Cart 6

Operation	Method	Path	Label	Parameters
getSubscriberCart	GET	/subscriber/cart	Get Subscriber Cart	user_ns text required
addToCart	POST	/subscriber/add-to-cart	Add Item to Cart	user_ns text required variant_id integer required qty integer default 1
removeFromCart	DELETE	/subscriber/remove-from-cart	Remove Item from Cart	user_ns text required variant_id integer required
emptySubscriberCart	DELETE	/subscriber/empty-cart	Empty Cart	user_ns text required
cartPaid	POST	/subscriber/cart-paid	Check Out Cart (Mark Paid)	user_ns text required name text phone text email text shipping_method text payment_method text reference_no text note text address text suburb text state text postcode text country text tracking_no text
updateOrderStatus	POST	/subscriber/update-order-status	Update Order Status	user_ns text required order_id integer required status select(paid | ordered | processing | shipped | completed | cancelled | refunded) required

Team Label 4

Operation	Method	Path	Label	Parameters
teamLabels	GET	/team/labels	List Labels	limit integer Number of items in the response page integer Page number, between 1 and 100 name text Search for label name
teamCreateLabel	POST	/team/create-label	Create Label	name text required
teamDeleteLabel	DELETE	/team/delete-label	Delete Label	id integer required
teamDeleteLabelByName	DELETE	/team/delete-label-by-name	Delete Label By Name	name text required

Template 3

Operation	Method	Path	Label	Parameters
listTemplates	GET	/templates	List Templates	limit integer default 50 page integer default 1 name text
listTemplateInstallsByNs	GET	/template/{templateNs}/installs	List Installs by Template	templateNs text required limit integer default 50 page integer default 1
generateTemplateOneTimeLink	POST	/template/{templateNs}/generate-one-time-link	Generate Template Install Link	templateNs text required days integer default 7

Ticket List 7

Operation	Method	Path	Label	Parameters
teamTicketLists	GET	/team/ticket-lists	List Ticket Lists	limit integer Number of items in the response page integer Page number, between 1 and 100 name text Search for list name
teamTicketListFields	GET	/team/ticket-lists/{listId}/fields	List Ticket List Fields	listId integer required List Id
teamTicketListItems	GET	/team/ticket-lists/{listId}/items	List Ticket List Items	listId integer required List Id limit integer Number of items in the response page integer Page number, between 1 and 100 title text Search for list item title flow_ns text Search for list items by flow_ns user_ns text Search for list items by user_ns
teamTicketListLogData	GET	/team/ticket-lists/{listId}/log-data	List Ticket List Change Log	listId integer required List Id start_time integer unix timestamp between 6 month agos and now, e.g. 1786123679. end_time integer unix timestamp between 6 months ago and now, e.g. 1786123679. flow_ns text Search for list items by flow_ns user_ns text Search for list items by user_ns list_item_id integer the list item id column_name text Search for list items by column name, available values: select1, select2, limit integer Number of items in the response, between 1 and 100
teamCreateTicketListItem	POST	/team/ticket-lists/{listId}/create	Create Ticket List Item	listId integer required List Id title text required user_ns text required description text assignee integer text1 text text2 text text3 text text4 text text5 text select1 text available value can be option_key or option_code select2 text available value can be option_key or option_code select3 text available value can be option_key or option_code select4 text available value can be option_key or option_code select5 text available value can be option_key or option_code number1 integer number2 integer rating1 integer rating2 integer date1 text format: Y-m-d, example: 2024-10-15 date2 text format: Y-m-d, example: 2024-10-15
teamUpdateTicketListItem	PUT	/team/ticket-lists/{listId}/update/{listItemId}	Update Ticket List Item	listId integer required List Id listItemId integer required List Item Id title text description text assignee integer text1 text text2 text text3 text text4 text text5 text select1 text available value can be option_key or option_code select2 text available value can be option_key or option_code select3 text available value can be option_key or option_code select4 text available value can be option_key or option_code select5 text available value can be option_key or option_code number1 integer number2 integer rating1 integer rating2 integer date1 text format: Y-m-d, example: 2024-10-15 date2 text format: Y-m-d, example: 2024-10-15
teamDeleteTicketListItem	DELETE	/team/ticket-lists/{listId}/delete/{listItemId}	Delete Ticket List Item	listId integer required List Id listItemId integer required List Item Id

User 5

Operation	Method	Path	Label	Parameters
UserInfo	GET	/me	Get Current User Info	no parameters
RecentNotifications	GET	/notifications/recent	List Recent Notifications & Announcements	no parameters
MarkAnnouncementAsRead	POST	/announcements/read	Mark Announcement As Read	no parameters
MarkNotificationAsRead	POST	/notifications/read	Mark Notification As Read	notification_id text
userChangePassword	PUT	/user/change-password	Change Password	current_password text required password text required at least 8 characters, must contain at least one uppercase letter and one password_confirmation text required

WhatsApp Template 4

Operation	Method	Path	Label	Parameters
listWhatsAppTemplates	POST	/whatsapp-template/list	List WhatsApp Templates	limit integer default 50 page integer default 1 name text
createWhatsAppTemplate	POST	/whatsapp-template/create	Create WhatsApp Template	name text language text category text components text
deleteWhatsAppTemplate	DELETE	/whatsapp-template/delete	Delete WhatsApp Template	name text required
syncWhatsAppTemplates	POST	/whatsapp-template/sync	Sync WhatsApp Templates	no parameters

Workspace 11

Operation	Method	Path	Label	Parameters
AnalyticsFlowAgentSummary	GET	/flow-agent-summary	Get Flow Agent Summary	range text Available ranges: yesterday (default), last_7_days, flow_ns text use this to return only the summary for one bot
AnalyticsFlowSummary	GET	/flow-summary	Get Flow Summary	range text Available ranges: yesterday (default), last_7_days, flow_ns text use this to return only the summary for one bot
teamBotUsers	GET	/team-bot-users	List Bot Users	limit integer Number of items in the response, between 1 and 100 page integer Page number, between 1 and 1000 name text Search for subscriber name phone text Search for subscriber phone email text Search for subscriber email is_channel text Search for subscriber is from channel, available value facebook, is_opt_in_email text Search for subscriber is opted in email, available value yes, no is_opt_in_sms text Search for subscriber is opted in SMS, available value yes, no is_interacted_in_last_24h text Search for subscriber is interacted within last 24 hours, available value is_bot_interacted_in_last_24h text Search for subscribers have bot interacted within last 24 hours, available is_last_message_in_last_24h text Search for subscribers have last message within last 24 hours, including
workspaceBots	GET	/team-flows	List Bots	limit integer Number of items in the response page integer Page number, between 1 and 100 name text Search for bot name type text Filter by channel type, available type: web, facebook, instagram, whatsapp,
workspaceInfo	GET	/team-info	Get Workspace Info	no parameters
workspaceMembers	GET	/team-members	List Members	limit integer Number of items in the response page integer Page number, between 1 and 100 name text Search for agent name role text Filter by role, available role: owner, admin, member, agent
workspaceSettingsChannels	GET	/workspace-settings/channels	Get Workspace Channels Settings	no parameters
workspaceSettingsLiveChatSidebar	GET	/workspace-settings/live-chat-sidebar	Get Live-Chat Sidebar Settings	no parameters
workspaceSettingsChannelsUpdate	POST	/workspace-settings/update-channels	Update Workspace Channels Settings	chat integer 1 to show, 0 to hide facebook integer 1 to show, 0 to hide instagram integer 1 to show, 0 to hide telegram integer 1 to show, 0 to hide slack integer 1 to show, 0 to hide whatsapp integer 1 to show, 0 to hide whatsapp_cloud integer 1 to show, 0 to hide wechat integer 1 to show, 0 to hide voice integer 1 to show, 0 to hide sms integer 1 to show, 0 to hide rcs integer 1 to show, 0 to hide line integer 1 to show, 0 to hide viber integer 1 to show, 0 to hide vk integer 1 to show, 0 to hide intercom integer 1 to show, 0 to hide jivochat integer 1 to show, 0 to hide chatwoot integer 1 to show, 0 to hide tiktok integer 1 to show, 0 to hide
workspaceSettingsLiveChatSidebarUpdate	POST	/workspace-settings/update-live-chat-sidebar	Update Live-Chat Sidebar Settings	data array<text>
listWaCallLogs	GET	/wa-call-logs	List WhatsApp Call Logs	limit integer default 50 page integer default 1 call_id text flow_ns text phone_number_id text direction select(inbound | outbound) status text