דלג לתוכן הראשי

Tool reference

Every API operation is available as a tool. The risk tier decides whether it needs confirmation before it runs.

Risk tiers

read83Reads data. No state change.
write101Reversible change.
send17Delivers a message to one person.
broadcast8Delivers to many. Confirmation required.
destructive34Irreversible. Confirmation required.

Subscribers (40)

Find, create and update subscribers; tags, labels, fields, opt-in state.

ToolTierEndpointDescription
cigchat_get_subscriberreadGET /subscriber/get-infoGet subscriber info
cigchat_get_subscriber_by_user_idreadGET /subscriber/get-info-by-user-idGet subscriber info by user unique id from channel, e.g. Facebook user id, WhatsApp user id, WeChat user id...
cigchat_search_subscribersreadGET /subscribersGet list of subscribers by seaching for name, phone, email, tag, custom user field and so on.
cigchat_subscriber_add_labels_by_namewritePOST /subscriber/add-labels-by-nameAdd labels by label name to subscriber, up to 20 labels
cigchat_subscriber_add_tagwritePOST /subscriber/add-tagAdd tag to subscriber
cigchat_subscriber_add_tag_by_namewritePOST /subscriber/add-tag-by-nameAdd tag to subscriber by tag name
cigchat_subscriber_add_tagswritePOST /subscriber/add-tagsAdd tags to subscriber, up to 20 tags
cigchat_subscriber_add_tags_by_namewritePOST /subscriber/add-tags-by-nameAdd tags by tag name to subscriber, up to 20 tags
cigchat_subscriber_assign_agentwritePOST /subscriber/assign-agentAssign agent to chat
cigchat_subscriber_assign_agent_groupwritePOST /subscriber/assign-agent-groupAssign agent group to chat
cigchat_subscriber_chat_messagesreadGET /subscriber/chat-messagesGet list of subscriber chat messages. type: in -> Incoming message from bot user, out -> Ougoing message from bot, agent -> Outgoing message from human agent, note -> Private note, system -> system messages
cigchat_subscriber_chat_messages_by_midsreadPOST /subscriber/chat-messages-by-midsGet chat messages by multiple mids, up to 100 mids. type: in -> Incoming message from bot user, out -> Ougoing message from bot, agent -> Outgoing message from human agent
cigchat_subscriber_clear_user_fieldwriteDELETE /subscriber/clear-user-fieldClear subscriber user field value
cigchat_subscriber_clear_user_field_by_namewriteDELETE /subscriber/clear-user-field-by-nameClear subscriber user field value by field name
cigchat_subscriber_clear_user_fieldswriteDELETE /subscriber/clear-user-fieldsClear multiple subscriber user fields, up to 20 user fields
cigchat_subscriber_clear_user_fields_by_namewriteDELETE /subscriber/clear-user-fields-by-nameClear multiple subscriber user fields, up to 20 user fields
cigchat_subscriber_createwritePOST /subscriber/createCreate new subscriber, phone or email is required
cigchat_subscriber_create_manywritePOST /subscriber/create-manyCreate new subscribers, phone or email is required
cigchat_subscriber_deletedestructiveDELETE /subscriber/deleteDelete subscriber
cigchat_subscriber_log_custom_eventsendPOST /subscriber/log-custom-eventLog custom event
cigchat_subscriber_move_chat_towritePOST /subscriber/move-chat-toUpdate chat status
cigchat_subscriber_opt_in_emailwritePOST /subscriber/opt-in-emailOpt-in Email
cigchat_subscriber_opt_in_smswritePOST /subscriber/opt-in-smsOpt-in SMS
cigchat_subscriber_opt_out_emailwriteDELETE /subscriber/opt-out-emailOpt-out Email
cigchat_subscriber_opt_out_smswriteDELETE /subscriber/opt-out-smsOpt-out SMS
cigchat_subscriber_pause_botwritePOST /subscriber/pause-botPause bot automation to subscriber
cigchat_subscriber_remove_labels_by_namewriteDELETE /subscriber/remove-labels-by-nameRemove labels from subscriber by label name, up to 20 labels
cigchat_subscriber_remove_tagwriteDELETE /subscriber/remove-tagRemove tag from subscriber
cigchat_subscriber_remove_tag_by_namewriteDELETE /subscriber/remove-tag-by-nameRemove tag from subscriber by tag name
cigchat_subscriber_remove_tagswriteDELETE /subscriber/remove-tagsRemove tags from subscriber, up to 20 tags
cigchat_subscriber_remove_tags_by_namewriteDELETE /subscriber/remove-tags-by-nameRemove tags from subscriber by tag name, up to 20 tags
cigchat_subscriber_resume_botwritePOST /subscriber/resume-botResume bot automation to subscriber
cigchat_subscriber_set_user_fieldwritePUT /subscriber/set-user-fieldSet or update subscriber user field value
cigchat_subscriber_set_user_field_by_namewritePUT /subscriber/set-user-field-by-nameSet or update subscriber user field value by field name
cigchat_subscriber_set_user_fieldswritePUT /subscriber/set-user-fieldsSet or update subscriber multiple user field value, up to 20 user fields
cigchat_subscriber_set_user_fields_by_namewritePUT /subscriber/set-user-fields-by-nameSet or update subscriber multiple user field value, up to 20 user fields
cigchat_subscriber_subscribe_to_botwritePOST /subscriber/subscribe-to-botSubscribe to bot
cigchat_subscriber_unassign_agentwritePOST /subscriber/unassign-agentUnassign agent from chat
cigchat_subscriber_unsubscribe_from_botwriteDELETE /subscriber/unsubscribe-from-botUnsubscribe from bot
cigchat_subscriber_updatewritePUT /subscriber/updateUpdate subscriber data

Flow (43)

Sub-flows, tags, user fields, bot fields, shortcuts, closing notes, segments.

ToolTierEndpointDescription
cigchat_flow_agentsreadGET /flow/agentsGet list of agents
cigchat_flow_bot_fieldsreadGET /flow/bot-fieldsGet list of bot fields by flow
cigchat_flow_bot_users_countreadGET /flow/bot-users-countGet count of bot users status
cigchat_flow_chat_button_widgetsreadGET /flow/chat-button-widgetsGet list of chat button widgets
cigchat_flow_create_bot_fieldwritePOST /flow/create-bot-fieldcreate new bot field
cigchat_flow_create_closing_notewritePOST /flow/create-closing-noteCreate a closing note for the current flow
cigchat_flow_create_shortcutwritePOST /flow/create-shortcutCreate a shortcut for the current flow
cigchat_flow_create_tagwritePOST /flow/create-tagcreate new tag
cigchat_flow_create_user_fieldwritePOST /flow/create-user-fieldcreate new user field
cigchat_flow_custom_events_datareadGET /flow/custom-events/dataGet the flow custom event data
cigchat_flow_custom_events_summaryreadGET /flow/custom-events/summaryGet the flow custom event summary
cigchat_flow_delete_bot_fielddestructiveDELETE /flow/delete-bot-fieldDelete bot field
cigchat_flow_delete_bot_field_by_namedestructiveDELETE /flow/delete-bot-field-by-nameDelete bot field by name
cigchat_flow_delete_closing_notedestructiveDELETE /flow/delete-closing-noteDelete a closing note from the current flow
cigchat_flow_delete_shortcutdestructiveDELETE /flow/delete-shortcutDelete a shortcut from the current flow
cigchat_flow_delete_sub_flowdestructiveDELETE /flow/delete-sub-flowDelete sub flow
cigchat_flow_delete_tagdestructiveDELETE /flow/delete-tagDelete tag
cigchat_flow_delete_tag_by_namedestructiveDELETE /flow/delete-tag-by-nameDelete tag by tag name
cigchat_flow_delete_user_fielddestructiveDELETE /flow/delete-user-fieldDelete user field
cigchat_flow_delete_user_field_by_namedestructiveDELETE /flow/delete-user-field-by-nameDelete user field by name
cigchat_flow_inbound_webhooksreadGET /flow/inbound-webhooksGet list of inbound webhooks by flow
cigchat_flow_set_bot_fieldwritePUT /flow/set-bot-fieldupdate bot field value
cigchat_flow_set_bot_field_by_namewritePUT /flow/set-bot-field-by-nameupdate bot field value by bot field name
cigchat_flow_set_bot_fieldswritePUT /flow/set-bot-fieldsupdate multiple bot fields value, up to 20 bot fields
cigchat_flow_set_bot_fields_by_namewritePUT /flow/set-bot-fields-by-nameupdate multiple bot fields value by field name, up to 20 bot fields
cigchat_flow_set_default_start_flowwritePOST /flow/set-default-start-flowSet default bot start flow, use main to reset the start flow to main flow
cigchat_flow_set_web_chat_widget_default_start_flowwritePOST /flow/set-web-chat-widget-default-start-flowSet default start flow for web chat widget, use main to set the start flow to main flow
cigchat_flow_settings_get_default_ai_providerreadGET /flow/settings/get-default-ai-providerGet default ai provider and model, available ai_provider: openai, deepseek, xai, claude, gemini, groq, ainvented
cigchat_flow_settings_set_audio_transcriptionwritePOST /flow/settings/set-audio-transcriptionSet audio transcription, available values: none,whisper-1,gpt-4o-transcribe,gpt-4o-mini-transcribe,whisper-large-v3-turbo,gemini-2.5-flash,gemini-3-flash-preview
cigchat_flow_settings_set_default_ai_providerwritePOST /flow/settings/set-default-ai-providerSet default ai provider and model, available ai_provider: openai, deepseek, xai, claude, gemini, groq, ainvented
cigchat_flow_template_installsreadGET /flow/template-installsGet list of template installs in this flow
cigchat_flow_update_closing_notewritePUT /flow/update-closing-noteUpdate a closing note in the current flow
cigchat_flow_update_shortcutwritePUT /flow/update-shortcutUpdate a shortcut in the current flow
cigchat_flow_update_user_fieldwritePOST /flow/update-user-fieldUpdate user field name or display_type
cigchat_flow_user_fieldsreadGET /flow/user-fieldsGet list of user fields by flow
cigchat_get_closing_notereadGET /flow/closing-notes/{id}Get a closing note from the current flow
cigchat_get_shortcutreadGET /flow/shortcuts/{id}Get a shortcut from the current flow
cigchat_list_closing_notesreadGET /flow/closing-notesGet closing notes for the current flow
cigchat_list_custom_eventsreadGET /flow/custom-eventsGet list of custom events by flow
cigchat_list_segmentsreadGET /flow/segmentsGet list of segments by flow
cigchat_list_shortcutsreadGET /flow/shortcutsGet shortcuts for the current flow
cigchat_list_subflowsreadGET /flow/subflowsGet list of sub flows
cigchat_list_tagsreadGET /flow/tagsGet list of tags by flow

Conversations (2)

Conversation history and agent activity.

ToolTierEndpointDescription
cigchat_flow_agent_activity_log_datareadGET /flow/agent-activity-log/dataGet the flow agent activity log data
cigchat_flow_conversations_datareadGET /flow/conversations/dataGet the flow conversation data, only return the closed conversations

WhatsApp & Meta templates (8)

WhatsApp and Facebook utility message templates.

ToolTierEndpointDescription
cigchat_facebook_utility_message_template_createwritePOST /facebook-utility-message-template/createCreate Facebook utility message template
cigchat_facebook_utility_message_template_deletedestructiveDELETE /facebook-utility-message-template/deleteDelete Facebook utility message template
cigchat_facebook_utility_message_template_listreadPOST /facebook-utility-message-template/listList Facebook utility message templates
cigchat_facebook_utility_message_template_syncwritePOST /facebook-utility-message-template/syncSync Facebook utility message templates
cigchat_whatsapp_template_createwritePOST /whatsapp-template/createCreate Whatsapp template, check https://developers.facebook.com/docs/graph-api/reference/whats-app-business-account/message_templates/#Creating
cigchat_whatsapp_template_deletedestructiveDELETE /whatsapp-template/deleteDelete Whatsapp template
cigchat_whatsapp_template_listreadPOST /whatsapp-template/listList Whatsapp templates
cigchat_whatsapp_template_syncwritePOST /whatsapp-template/syncSync Whatsapp templates

Messaging (21)

Send to one subscriber, or broadcast to many. Handle with care.

ToolTierEndpointDescription
cigchat_broadcast_by_segmentbroadcastPOST /subscriber/broadcast-by-segmentBroadcast sub flow by segments, available types: EMAIL,SMS,WHATSAPP_TEMPLATE,FACEBOOK_NOTIFICATION
cigchat_broadcast_by_tagbroadcastPOST /subscriber/broadcast-by-tagBroadcast sub flow by tags, available types: EMAIL,SMS,WHATSAPP_TEMPLATE,FACEBOOK_NOTIFICATION
cigchat_broadcast_by_user_idbroadcastPOST /subscriber/broadcast-by-user-idBroadcast sub flow by user ids, available types: EMAIL,SMS,WHATSAPP_TEMPLATE,FACEBOOK_NOTIFICATION
cigchat_broadcast_fb_utility_template_by_tagbroadcastPOST /subscriber/broadcast-facebook-utility-message-template-by-tagBroadcast Facebook utility message template by tags
cigchat_broadcast_fb_utility_template_by_user_idbroadcastPOST /subscriber/broadcast-facebook-utility-message-template-by-user-idBroadcast Facebook utility message template by user ids
cigchat_broadcast_to_listbroadcastPOST /subscriber/broadcastBroadcast sub flow by user ns list, available types: EMAIL,SMS,WHATSAPP_TEMPLATE,FACEBOOK_NOTIFICATION
cigchat_broadcast_whatsapp_template_by_tagbroadcastPOST /subscriber/broadcast-whatsapp-template-by-tagBroadcast whatsapp template by tags, you can find the namespace, name, lang, params from /api/whatapp-template/list, use use_default_values or params for wa_template
cigchat_broadcast_whatsapp_template_by_user_idbroadcastPOST /subscriber/broadcast-whatsapp-template-by-user-idBroadcast whatsapp template by user ids, you can find the namespace, name, lang, params from /api/whatapp-template/list, use use_default_values or params for wa_template
cigchat_send_contentsendPOST /subscriber/send-contentSend content to subscriber, learn more about how to use dynamic content
cigchat_send_emailsendPOST /subscriber/send-emailSend email content to subscriber
cigchat_send_fb_utility_templatesendPOST /subscriber/send-facebook-utility-message-templateSend Facebook utility message template to subscriber
cigchat_send_fb_utility_template_by_user_idsendPOST /subscriber/send-facebook-utility-message-template-by-user-idSend Facebook utility message template to subscriber by user id
cigchat_send_main_flowsendPOST /subscriber/send-main-flowSend main flow to subscriber
cigchat_send_nodesendPOST /subscriber/send-nodeSend node to subscriber
cigchat_send_smssendPOST /subscriber/send-smsSend sms content to subscriber
cigchat_send_subflowsendPOST /subscriber/send-sub-flowSend sub flow to subscriber
cigchat_send_subflow_by_namesendPOST /subscriber/send-sub-flow-by-flow-nameSend sub flow to subscriber by flow name
cigchat_send_subflow_by_user_idsendPOST /subscriber/send-sub-flow-by-user-idSend sub flow to subscriber by the unique user id from each channel
cigchat_send_textsendPOST /subscriber/send-textSend text content to subscriber
cigchat_send_whatsapp_templatesendPOST /subscriber/send-whatsapp-templateSend Whatsapp Template to subscriber, you can find the namespace, name, lang, params from /api/whatapp-template/list
cigchat_send_whatsapp_template_by_user_idsendPOST /subscriber/send-whatsapp-template-by-user-idSend Whatsapp Template to subscriber, you can find the namespace, name, lang, params from /api/whatapp-template/list

Shop (49)

Products, variants, types, vendors, tags, orders, discounts, locations, carts.

ToolTierEndpointDescription
cigchat_create_product_tagwritePOST /shop/product-tags/createCreate new tag
cigchat_delete_product_tagdestructiveDELETE /shop/product-tags/{tagId}/deleteDelete tag
cigchat_get_product_tagreadGET /shop/product-tags/{tagId}/get-infoGet tag info
cigchat_list_discount_codesreadGET /shop/discount-codesGet list of discount codes
cigchat_list_ordersreadGET /shop/ordersGet list of orders
cigchat_list_product_tagsreadGET /shop/product-tagsGet list of product tags
cigchat_list_product_typesreadGET /shop/product-typesGet list of product types
cigchat_list_product_vendorsreadGET /shop/product-vendorsGet list of product vendors
cigchat_list_productsreadGET /shop/productsGet list of products
cigchat_list_shop_locationsreadGET /shop/locationsGet list of locations
cigchat_shop_business_hours_inforeadGET /shop/business-hours/infoGet store business hours
cigchat_shop_business_hours_updatewritePUT /shop/business-hours/updateUpdate store business hours. id, available values: 1, 2, 3, 4, 5, 6, 7 name, available values: Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday option, available values: open, close, open_1, open_2 start, required if option is open_1 or open_2, available values: between 00:00 and 23:45, stepping by 00:15 end, required if option is open_1 or open_2, available values: between 00:00 and 24:00, stepping by 00:15 start_2, required if option is open_2, available values: between 00:00 and 23:45, stepping by 00:15 end_2, required if option is open_2, available values: between 00:00 and 24:00, stepping by 00:15
cigchat_shop_discount_codes_createwritePOST /shop/discount-codes/createCreate new tag
cigchat_shop_discount_codes_deletedestructiveDELETE /shop/discount-codes/{codeId}/deleteDelete discount code
cigchat_shop_discount_codes_delete_by_codedestructiveDELETE /shop/discount-codes/delete-by-codeDelete discount code by code
cigchat_shop_discount_codes_get_inforeadGET /shop/discount-codes/{codeId}/get-infoGet discount code info
cigchat_shop_discount_codes_get_info_by_codereadGET /shop/discount-codes/get-info-by-codeGet discount code info by code
cigchat_shop_discount_codes_updatewritePUT /shop/discount-codes/{codeId}/updateUpdate discount code.
cigchat_shop_locations_createwritePOST /shop/locations/createCreate new location
cigchat_shop_locations_deletedestructiveDELETE /shop/locations/{locationId}/deleteDelete location
cigchat_shop_locations_get_inforeadGET /shop/locations/{locationId}/get-infoGet lcoation info
cigchat_shop_locations_updatewritePUT /shop/locations/{locationId}/updateUpdate location.
cigchat_shop_orders_createwritePOST /shop/orders/createCreate new order for bot user
cigchat_shop_orders_get_inforeadGET /shop/orders/{orderId}/get-infoGet order info
cigchat_shop_orders_updatewritePUT /shop/orders/{orderId}/updateUpdate order
cigchat_shop_product_types_createwritePOST /shop/product-types/createCreate new type
cigchat_shop_product_types_deletedestructiveDELETE /shop/product-types/{typeId}/deleteDelete type
cigchat_shop_product_types_get_inforeadGET /shop/product-types/{typeId}/get-infoGet type info
cigchat_shop_product_types_updatewritePUT /shop/product-types/{typeId}/updateUpdate type name.
cigchat_shop_product_vendors_createwritePOST /shop/product-vendors/createCreate new vendor
cigchat_shop_product_vendors_deletedestructiveDELETE /shop/product-vendors/{vendorId}/deleteDelete vendor
cigchat_shop_product_vendors_get_inforeadGET /shop/product-vendors/{vendorId}/get-infoGet vendor info
cigchat_shop_product_vendors_updatewritePUT /shop/product-vendors/{vendorId}/updateUpdate vendor name.
cigchat_shop_products_createwritePOST /shop/products/createCreate new product
cigchat_shop_products_deletedestructiveDELETE /shop/products/{productId}/deleteDelete product
cigchat_shop_products_get_inforeadGET /shop/products/{productId}/get-infoGet product info
cigchat_shop_products_updatewritePUT /shop/products/{productId}/updateUpdate product info only. To update variants, use /shop/products/update-variant
cigchat_shop_products_variantsreadGET /shop/products/{productId}/variantsGet list of product variants
cigchat_shop_products_variants_createwritePOST /shop/products/{productId}/variants/createCreate new product variant
cigchat_shop_products_variants_deletedestructiveDELETE /shop/products/{productId}/variants/{variantId}/deleteDelete product variant
cigchat_shop_products_variants_get_inforeadGET /shop/products/{productId}/variants/{variantId}/get-infoGet product variant info
cigchat_shop_products_variants_updatewritePUT /shop/products/{productId}/variants/{variantId}/updateUpdate product variant info
cigchat_subscriber_add_to_cartwritePOST /subscriber/add-to-cartAdd item to subscriber shopping cart
cigchat_subscriber_cartreadGET /subscriber/cartGet subscriber shopping cart detail
cigchat_subscriber_cart_paidsendPOST /subscriber/cart-paidCheckout subscriber shopping cart and mark as paid
cigchat_subscriber_empty_cartwriteDELETE /subscriber/empty-cartEmpty subscriber shopping cart items
cigchat_subscriber_remove_from_cartwriteDELETE /subscriber/remove-from-cartRemove item from subscriber shopping cart
cigchat_subscriber_update_order_statussendPOST /subscriber/update-order-statusUpdate order status to paid,ordered,processing,shipped,completed,cancelled,refunded
cigchat_update_product_tagwritePUT /shop/product-tags/{tagId}/updateUpdate tag name.

Team (17)

Ticket lists, team labels and agent groups.

ToolTierEndpointDescription
cigchat_team_agent_groupreadGET /team/agent-group/{id}Get agent group information and members
cigchat_team_agent_groupsreadGET /team/agent-groupsGet list of Agent Groups
cigchat_team_create_agent_groupwritePOST /team/create-agent-groupcreate new agent group
cigchat_team_create_labelwritePOST /team/create-labelcreate new label
cigchat_team_delete_agent_groupdestructiveDELETE /team/delete-agent-group/{id}Delete agent group
cigchat_team_delete_labeldestructiveDELETE /team/delete-labelDelete label
cigchat_team_delete_label_by_namedestructiveDELETE /team/delete-label-by-nameDelete label by label name
cigchat_team_labelsreadGET /team/labelsGet list of labels
cigchat_team_ticket_listsreadGET /team/ticket-listsGet list of ticket lists
cigchat_team_ticket_lists_createwritePOST /team/ticket-lists/{listId}/createcreate new ticket
cigchat_team_ticket_lists_deletedestructiveDELETE /team/ticket-lists/{listId}/delete/{listItemId}delete a ticket
cigchat_team_ticket_lists_fieldsreadGET /team/ticket-lists/{listId}/fieldsGet list of ticket list fields
cigchat_team_ticket_lists_itemsreadGET /team/ticket-lists/{listId}/itemsGet list of ticket list items
cigchat_team_ticket_lists_log_datareadGET /team/ticket-lists/{listId}/log-dataGet the ticket list change log data
cigchat_team_ticket_lists_updatewritePUT /team/ticket-lists/{listId}/update/{listItemId}update a ticket, include only the fields that need to be changed
cigchat_team_update_agent_groupwritePUT /team/update-agent-group/{id}update agent group
cigchat_team_update_agent_group_userswritePOST /team/update-agent-group-users/{id}update agent group members

AI (13)

AI agents and tasks, provider settings, OpenAI embeddings.

ToolTierEndpointDescription
cigchat_flow_ai_agent_inforeadPOST /flow/ai-agent-infoView Ai Agent details, including description, prompts, ai function list and more
cigchat_flow_ai_agentsreadGET /flow/ai-agentsGet list of ai agents by flow
cigchat_flow_ai_task_inforeadPOST /flow/ai-task-infoView Ai Task details
cigchat_flow_ai_tasksreadGET /flow/ai-tasksGet list of ai tasks by flow
cigchat_flow_update_ai_agent_providerwritePOST /flow/update-ai-agent-providerupdate Ai Agent provider and model, available ai_provider: openai, openai-responses, deepseek, xai, xai-responses, claude, gemini, groq, ainvented
cigchat_flow_update_ai_task_providerwritePOST /flow/update-ai-task-providerupdate Ai Task provider and model, available ai_provider: openai, deepseek, xai, claude, gemini, groq, ainvented
cigchat_openai_embeddingsreadGET /openai-embeddingsGet list of OpenAI Embeddings
cigchat_openai_embeddings_createwritePOST /openai-embeddings/createCreate new embedding
cigchat_openai_embeddings_deletedestructiveDELETE /openai-embeddings/{id}/deleteDelete embedding
cigchat_openai_embeddings_generatewritePOST /openai-embeddings/generateRegenerate embeddings
cigchat_openai_embeddings_get_inforeadGET /openai-embeddings/{id}/get-infoGet embedding info
cigchat_openai_embeddings_importwritePOST /openai-embeddings/importImport OpenAI Embeddings, maximum 100 embeddings, max characters for each heading is 50, max characters for each text is 1000
cigchat_openai_embeddings_updatewritePUT /openai-embeddings/{id}/updateUpdate embeding heading and text.

Integrations (30)

Third-party integration credentials and mini-apps.

ToolTierEndpointDescription
cigchat_clear_integration_ainventeddestructiveDELETE /integration/ainventedClear the config of Ainvented integration
cigchat_clear_integration_caludedestructiveDELETE /integration/caludeClear the config of CaludeAi integration
cigchat_clear_integration_dropidestructiveDELETE /integration/dropiClear the config of Dropi integration
cigchat_clear_integration_meta_conversions_apidestructiveDELETE /integration/meta-conversions-apiClear the config of Meta Conversions Api integration
cigchat_clear_integration_openaidestructiveDELETE /integration/openaiClear the config of OpenAi integration
cigchat_clear_integration_s3storagedestructiveDELETE /integration/s3storageClear the config of S3 Storage integration
cigchat_clear_integration_shopifydestructiveDELETE /integration/shopifyClear the config of shopify integration
cigchat_clear_integration_woocommercedestructiveDELETE /integration/woocommerceClear the config of WooCommerce integration
cigchat_clear_integration_xaidestructiveDELETE /integration/xaiClear the config of XAi integration
cigchat_get_integration_ainventedreadGET /integration/ainventedGet the config of Ainvented integration
cigchat_get_integration_dropireadGET /integration/dropiGet the config of Dropi integration
cigchat_get_integration_meta_conversions_apireadGET /integration/meta-conversions-apiGet the config of Meta Conversions Api integration
cigchat_get_integration_openaireadGET /integration/openaiGet the config of OpenAi integration
cigchat_get_integration_s3storagereadGET /integration/s3storageGet the config of S3 Storage integration
cigchat_get_integration_shopifyreadGET /integration/shopifyGet the config of shopify integration
cigchat_get_integration_woocommercereadGET /integration/woocommerceGet the config of WooCommerce integration
cigchat_get_integration_xaireadGET /integration/xaiGet the config of XAi integration
cigchat_installed_mini_app_listreadGET /installed-mini-app/listGet the list of installed mini apps
cigchat_installed_mini_app_update_api_keywritePOST /installed-mini-app/update-api-key/{app_id}Update the config of Installed mini app, only for the mini app with auth type apikey
cigchat_integration_claudereadGET /integration/claudeGet the config of CaludeAi integration
cigchat_set_integration_ainventedwritePOST /integration/ainventedUpdate the config of Ainvented integration
cigchat_set_integration_caludewritePOST /integration/caludeUpdate the config of CaludeAi integration
cigchat_set_integration_dropiwritePOST /integration/dropiUpdate the config of Dropi integration
cigchat_set_integration_meta_conversions_apiwritePOST /integration/meta-conversions-apiUpdate the config of Meta Conversions Api integration
cigchat_set_integration_openaiwritePOST /integration/openaiUpdate the config of OpenAi integration
cigchat_set_integration_s3storagewritePOST /integration/s3storageUpdate the config of S3 Storage integration
cigchat_set_integration_shopifywritePOST /integration/shopifyUpdate the config of shopify integration. For new custom app integration after 2026-02-01, use Client ID value in the api_key field, use Client Secret value in the token field
cigchat_set_integration_woocommercewritePOST /integration/woocommerceUpdate the config of WooCommerce integration
cigchat_set_integration_xaiwritePOST /integration/xaiUpdate the config of XAi integration
cigchat_subscriber_app_triggersendPOST /subscriber/app-triggerTrigger an app event on subscriber from installed min-app

Workspace (17)

Workspace settings, members, analytics and account info.

ToolTierEndpointDescription
cigchat_announcements_readwritePOST /announcements/readMark announcement as read
cigchat_flow_agent_summaryreadGET /flow-agent-summaryGet the flow agent summary
cigchat_flow_summaryreadGET /flow-summaryGet the flow summary
cigchat_mereadGET /meGet current user info
cigchat_media_libraryreadGET /media-libraryGet member-uploaded media
cigchat_notifications_readwritePOST /notifications/readMark notification as read
cigchat_notifications_recentreadGET /notifications/recentGet recent notifications and announcements
cigchat_team_bot_usersreadGET /team-bot-usersGet list of bot users by seaching for name, phone, email and so on.
cigchat_team_flowsreadGET /team-flowsGet list of workspace bots
cigchat_team_inforeadGET /team-infoGet workspace info
cigchat_team_membersreadGET /team-membersGet list of workspace members
cigchat_user_change_passwordwritePUT /user/change-passwordChange user password
cigchat_wa_call_logsreadGET /wa-call-logsGet paginated WhatsApp call logs for the workspace
cigchat_workspace_settings_channelsreadGET /workspace-settings/channelsGet workspace settings - Channels
cigchat_workspace_settings_live_chat_sidebarreadGET /workspace-settings/live-chat-sidebarGet workspace settings - Live Chat Sidebar
cigchat_workspace_settings_update_channelswritePOST /workspace-settings/update-channelsShow/Hide workspace Channels
cigchat_workspace_settings_update_live_chat_sidebarwritePOST /workspace-settings/update-live-chat-sidebarUpdate the workspace settings for live chat sidebar, available values: single_bot_style,disable_sidebar,hide_unanswered,hide_my_groups,hide_collaborating,hide_supervised,hide_unassigned,hide_agents,hide_agent_groups,hide_status,hide_spam,hide_invalid,hide_unread,hide_unsubscribed,hide_segments,hide_channels,hide_channel_facebook,hide_channel_instagram,hide_channel_whatsapp,hide_channel_whatsapp_cloud,hide_channel_telegram,hide_channel_tiktok,hide_channel_apple,hide_channel_google,hide_channel_line,hide_channel_viber,hide_channel_vk,hide_channel_wechat,hide_channel_web,hide_channel_sso-google,hide_channel_sso-facebook,hide_channel_sso-email,show_labels,show_boards,show_lead_status,show_department

Templates (3)

Flow templates and one-time install links.

ToolTierEndpointDescription
cigchat_list_templatesreadGET /templatesGet list of templates
cigchat_template_generate_one_time_linkwritePOST /template/{templateNs}/generate-one-time-linkGenerate template one time install link
cigchat_template_installsreadGET /template/{templateNs}/installsGet list of installs by template ns
בואו נתחיל