שׂיג ושׂיח · Cig.Chat

Delete Sub-flow

Delete a sub-flow by namespace.

Get Bot Users Count

Counts of subscribers by status.

Set Default Start Flow

Configure the default entry sub-flow.

Set Web-Chat Default Start Flow

Configure the entry sub-flow for the web-chat widget.

Create Tag

Create a new tag.

Delete Tag

Delete a tag by namespace.

Delete Tag by Name

Delete a tag by its display name.

Create User Field

Create a custom user field.

Update User Field

Update a custom user field.

Delete User Field

Delete a custom user field by namespace.

Delete User Field by Name

Delete a custom user field by name.

Create Bot Field

Create a bot-level field.

Set Bot Field

Set a bot-field value by namespace.

Set Bot Field by Name

Set a bot-field value by name.

Set Multiple Bot Fields

Set up to 20 bot-fields by namespace in one call.

Set Multiple Bot Fields by Name

Set up to 20 bot-fields by name in one call.

Delete Bot Field

Delete a bot-field by namespace.

Delete Bot Field by Name

Delete a bot-field by name.

Update AI Agent Provider

Change an AI agent's provider/model.

Update AI Task Provider

Change an AI task's provider/model.

Set Default AI Provider

Set the bot's default AI provider/model.

Set Audio Transcription Model

Set the speech-to-text model.

Get Custom Events Summary

Aggregated stats for a custom event.

Log Custom Event

Record a custom event for a subscriber.

Move Chat To

Update chat status (open / in_progress / done).

Assign Agent

Assign an agent to a subscriber's conversation.

Assign Agent Group

Assign an agent group to a subscriber.

Unassign Agent

Remove agent assignment from a subscriber.

Pause Bot

Pause automation for this subscriber.

Resume Bot

Resume automation for this subscriber.

Create WhatsApp Template

Create a new WhatsApp template.

Delete WhatsApp Template

Delete a WhatsApp template by name.

Sync WhatsApp Templates

Re-sync WhatsApp templates from Meta.

Get Subscriber Info

Look up a subscriber by namespace.

Get Subscriber Info by Channel User ID

Look up a subscriber by channel user ID.

Create Subscriber

Create a single subscriber. Phone or email is required.

Create Subscribers (Bulk)

Create up to 100 subscribers in one call.

Update Subscriber

Modify a subscriber's profile.

Delete Subscriber

Delete a subscriber.

Add Tag to Subscriber

Add a single tag to a subscriber.

Add Tag to Subscriber by Name

Add a tag (by name) to a subscriber.

Add Multiple Tags to Subscriber

Add up to 20 tags to a subscriber.

Add Multiple Tags to Subscriber by Name

Add up to 20 tags by name.

Remove Tag from Subscriber

Remove a single tag.

Remove Tag from Subscriber by Name

Remove a tag by name.

Remove Multiple Tags from Subscriber

Remove up to 20 tags by namespace.

Remove Multiple Tags from Subscriber by Name

Remove up to 20 tags by name.

Add Labels to Subscriber

Add up to 20 labels by name.

Remove Labels from Subscriber

Remove up to 20 labels by name.

Set User Field

Set a user-field value by namespace.

Set User Field by Name

Set a user-field value by name.

Set Multiple User Fields

Set up to 20 user-field values by namespace.

Set Multiple User Fields by Name

Set up to 20 user-field values by name.

Clear User Field

Clear a user-field value by namespace.

Clear User Field by Name

Clear a user-field value by name.

Clear Multiple User Fields

Clear up to 20 user-fields by namespace.

Clear Multiple User Fields by Name

Clear up to 20 user-fields by name.

Subscribe to Bot

Enable bot subscription for this user.

Unsubscribe from Bot

Disable bot subscription for this user.

Opt-in SMS

Enable SMS for this user.

Opt-out SMS

Disable SMS for this user.

Opt-in Email

Enable email for this user.

Opt-out Email

Disable email for this user.

Trigger App Event

Trigger a mini-app event with arbitrary context.

Send Main Flow

Initiate the bot's main flow for this subscriber.

Send Sub-flow

Send a sub-flow by namespace.

Send Sub-flow by Name

Send a sub-flow by display name.

Send Sub-flow by Channel User ID

Send a sub-flow to a channel user ID.

Send Text Message

Send a free-form text message.

Send SMS

Send an SMS to this subscriber.

Send Email

Send an email to this subscriber.

Send Node

Send a specific node from a flow.

Send WhatsApp Template

Send a WhatsApp template to this subscriber.

Send WhatsApp Template by Channel User ID

Send a WhatsApp template by channel user ID.

Send Content

Send a structured content payload.

Broadcast to List

Broadcast a sub-flow to up to 200 subscribers.

Broadcast by Channel User IDs

Broadcast a sub-flow to channel user IDs.

Broadcast WhatsApp Template by Channel User IDs

Broadcast a WhatsApp template to channel user IDs.

Broadcast by Tag

Broadcast a sub-flow to a tag-defined audience.

Broadcast WhatsApp Template by Tag

Broadcast a WhatsApp template by tag.

Broadcast by Segment

Broadcast a sub-flow to a segment.

Create Ticket List Item

Create a new ticket-list item with title, assignee and custom fields.

Update Ticket List Item

Update a ticket-list item — pass only the fields you want to change.

Delete Ticket List Item

Delete a ticket-list item.

List Labels

List team-level labels.

Create Label

Create a new team label.

Delete Label

Delete a team label by ID.

Delete Label By Name

Delete a team label by name.

View Agent Group

Get a single agent group and its members.

List Agent Groups

List agent groups on this workspace.

Create Agent Group

Create an agent group.

Set Agent Group Members

Replace the member list of an agent group.

Update Agent Group

Update an agent group (name, image, assignment policy).

Delete Agent Group

Delete an agent group by ID.

Get Dropi Integration Config

Read the Dropi integration configuration.

Get Meta Conversions API Config

Read the Meta Conversions API integration configuration.

Get OpenAI Integration Config

Read the OpenAI integration configuration on this workspace.

Get S3 Storage Integration Config

Read the S3 storage integration configuration.

Get Shopify Integration Config

Read the Shopify integration configuration on this workspace.

Get WooCommerce Integration Config

Read the WooCommerce integration configuration.

Update Mini-App API Key

Update the API key on an installed mini-app (auth type: apikey).

Update Dropi Integration Config

Configure the Dropi integration (API URL, API key).

Update Meta Conversions API Config

Configure the Meta Conversions API integration (access token, dataset ID).

Update OpenAI Integration Config

Configure the OpenAI integration (API key, organization ID).

Update S3 Storage Integration Config

Configure the S3 storage integration (endpoint, key, secret, bucket, region).

Update Shopify Integration Config

Configure the Shopify integration (domain, API key/Client ID, token/Client Secret, abandoned-cart wait).

Update WooCommerce Integration Config

Configure the WooCommerce integration (URL, consumer key/secret).

Clear Dropi Integration Config

Disconnect the Dropi integration.

Clear Meta Conversions API Config

Disconnect the Meta Conversions API integration.

Clear OpenAI Integration Config

Disconnect the OpenAI integration on this workspace.

Clear S3 Storage Integration Config

Disconnect the S3 storage integration.

Clear Shopify Integration Config

Disconnect the Shopify integration on this workspace.

Clear WooCommerce Integration Config

Disconnect the WooCommerce integration.

Get OpenAI Embedding Info

Get a single OpenAI embedding by ID.

Create OpenAI Embedding

Create a new OpenAI embedding (heading + text).

Regenerate OpenAI Embeddings

Regenerate the embedding vectors for all stored entries.

Import OpenAI Embeddings

Import OpenAI Embeddings, maximum 100 embeddings, max characters for each heading is 50, max characters for each text is 1000

Update OpenAI Embedding

Update the heading and/or text of an existing OpenAI embedding.

Delete OpenAI Embedding

Delete an OpenAI embedding by ID.

List Bot Users

Search bot users (subscribers) across the workspace.

List Bots

List bots in the workspace, optionally filtered by channel type.

Get Workspace Info

Read workspace metadata (name, plan, owner).

List Members

List workspace members, optionally filtered by role.

Get Workspace Channels Settings

Read which channels are visible in the workspace UI.

Get Live-Chat Sidebar Settings

Read live-chat sidebar visibility settings.

Update Workspace Channels Settings

Toggle which channels are visible in the workspace UI.

Update Live-Chat Sidebar Settings

Update live-chat sidebar visibility flags.

Get Current User Info

Read the current authenticated user.

Mark Announcement As Read

Mark an announcement as read.

Mark Notification As Read

Mark a notification as read.

Change Password

Change the current user password.

Create Facebook Utility Message Template

Create a Facebook utility-category message template.

Sync Facebook Utility Message Templates

Re-sync templates from Meta Business Manager.

Delete Facebook Utility Message Template

Delete a Facebook utility message template by name.

Make an API Call

Hit any cig.chat endpoint that isn't modeled by another module. The base URL and Authorization header are added automatically.

List Sub-flows

List sub-flows in this bot.

List Template Installs

Templates installed in this bot.

List Agents

List team agents (filterable by role).

List Inbound Webhooks

List inbound-webhook configurations on this bot.

List Chat Widgets

List chat-button widgets on this bot.

List Tags

List tags in this bot.

List User Fields

List custom user fields.

List Bot Fields

List bot-level fields.

List AI Agents

List AI agents with filters.

List AI Tasks

List AI tasks with filters.

List Segments

List segments in this bot.

List Custom Events

List custom-event definitions.

Get Custom Events Data

Detailed event log.

List Closed Conversations

Conversations closed within a date range.

List Agent Activity Log

Activity log filtered by user/agent/action.

Get Chat Messages

Message history for a subscriber.

Get Messages by IDs

Fetch up to 100 messages by their IDs.

List WhatsApp Templates

List WhatsApp message templates.

Search Subscribers

Search subscribers with filters.

List Ticket Lists

List ticket lists on this workspace.

List Ticket List Fields

List the fields (columns) of a ticket list.

List Ticket List Items

List items (rows) inside a ticket list.

List Ticket List Change Log

Read the change log for ticket-list items in a time range.

List Installed Mini-Apps

List mini-apps installed on this workspace.

List OpenAI Embeddings

List OpenAI embeddings stored on this workspace.

Get Flow Agent Summary

Per-agent analytics summary across selected flows.

Get Flow Summary

Workspace-wide flow analytics summary.

List Recent Notifications & Announcements

Recent notifications and announcements for the current user.

List Facebook Utility Message Templates

List Facebook utility message templates on this bot.