> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Zixflow

> AI-CRM and Messaging Across SMS, Email, and WhatsApp

![Zixflow logo](https://mintcdn.com/composio-preview/11RkPhDhzt1wdr6a/images/toolkits/zixflow.svg?fit=max\&auto=format\&n=11RkPhDhzt1wdr6a\&q=85\&s=dfd3197ac44a39d437503e1fb40aefed)

* **Category:** crm
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 7
* **Triggers:** 0
* **Slug:** `ZIXFLOW`
* **Version:** 20260615\_00

## Tools

> [accordion] Create Attribute
>
> **Slug:** `ZIXFLOW_CREATE_ATTRIBUTE`
>
> Tool to create a custom attribute for a Zixflow collection or list. Use when you need to add new fields to track specific data types (text, number, email, etc.). Attributes define the structure of your data. Common use cases: adding custom fields for contacts, creating status trackers, adding reference fields between collections.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Human-readable display name shown in the UI. Can contain spaces and special characters
>
> **config** `object` *required*
>
> Configuration object with settings specific to the inputType. Required fields vary by inputType (e.g., currency requires currencyCode)
>
> **target** `string ("collection" | "list")` *required*
>
> Type specification: either 'collection' or 'list' where the attribute will be created
>
> **isUnique** `boolean`
>
> Whether this attribute's value must be unique across all records in the target. Useful for identifiers like email or account ID
>
> **targetId** `string` *required*
>
> Unique identifier (MongoDB ObjectId format) for the target collection or list
>
> **inputType** `string ("text" | "number" | "checkbox" | "currency" | "date" | "timestamp" | "rating" | "status" | "select" | "multiselect" | "record-reference" | "actor-reference" | "domain" | "file" | "ai-wizard" | "email-address" | "phone-number")` *required*
>
> Field type that determines how data is stored and displayed. Choose based on the data you want to store
>
> **apiKeyName** `string` *required*
>
> API key identifier used for data storage and retrieval. Must be unique within the target. Use lowercase with underscores for consistency (e.g., 'test\_field', 'customer\_email')
>
> **isEditable** `boolean`
>
> Whether users can modify this attribute's value after creation. Set to False for system-managed fields
>
> **isRequired** `boolean`
>
> Whether this attribute must have a value when creating new records. Required fields prevent record creation if empty
>
> **description** `string`
>
> Detailed description of the attribute's purpose and usage, visible to users
>
> **defaultValue** `string`
>
> Default value assigned to this attribute when creating new records. Format depends on inputType
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get WhatsApp Campaign Report
>
> **Slug:** `ZIXFLOW_GET_CAMPAIGN_REPORT_WHATSAPP`
>
> Tool to retrieve WhatsApp campaign message report. Use when you need to check the delivery status and details of a WhatsApp message sent via campaign.
>
> #### Input Parameters
>
> **message\_id** `string` *required*
>
> The message ID received when sending the WhatsApp campaign
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Email Report
>
> **Slug:** `ZIXFLOW_GET_EMAIL_REPORT`
>
> Tool to retrieve email message delivery report from Zixflow. Use when you need to check the delivery status of a sent campaign email. The report includes delivery status (SENT, OPENED, CLICKED, BOUNCE, COMPLAINT, UNSUBSCRIBED), recipient information, and timestamps. Requires the message ID obtained when sending the campaign.
>
> #### Input Parameters
>
> **message\_id** `string` *required*
>
> The unique message ID that was received when sending the campaign. This is typically a 24-character MongoDB ObjectId format (hexadecimal string).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get SMS Report
>
> **Slug:** `ZIXFLOW_GET_SMS_REPORT`
>
> Tool to retrieve SMS message delivery report from Zixflow. Use when you need to check the delivery status, destination, and other details of a sent SMS campaign message.
>
> #### Input Parameters
>
> **messageId** `string` *required*
>
> The message ID that you received when sending the campaign
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get WhatsApp Template Variables
>
> **Slug:** `ZIXFLOW_GET_WHATSAPP_TEMPLATE_VARIABLES`
>
> Tool to retrieve template variable details for a WhatsApp template. Use when you need to understand what variables a specific WhatsApp template expects before sending a message.
>
> #### Input Parameters
>
> **phoneId** `string` *required*
>
> Unique identifier associated with the sender's phone number
>
> **language** `string` *required*
>
> Language code for the template (e.g., 'en' for English, 'es' for Spanish)
>
> **templateName** `string` *required*
>
> Name of the WhatsApp template to retrieve variables for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Attribute Options
>
> **Slug:** `ZIXFLOW_LIST_ATTRIBUTES_OPTIONS`
>
> Tool to retrieve the list of options for select/multiselect attributes. Use when you need to get available options for a specific attribute in a collection or list.
>
> #### Input Parameters
>
> **target** `string ("collection" | "list")` *required*
>
> Specifies the target type, which can be either 'collection' or 'list.'
>
> **targetId** `string` *required*
>
> Unique identifier for the target (collection ID or list ID)
>
> **attributeId** `string` *required*
>
> ID of the select or multiselect attribute
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Attribute Status Options
>
> **Slug:** `ZIXFLOW_LIST_ATTRIBUTES_STATUS`
>
> Tool to retrieve the list of options for status attributes in Zixflow. Use when you need to fetch available status configurations for a specific attribute within a collection or list.
>
> #### Input Parameters
>
> **target** `string ("collection" | "list")` *required*
>
> Specifies the target type, which can be either 'collection' or 'list'
>
> **targetId** `string` *required*
>
> Unique identifier for the target (collection ID or list ID)
>
> **attributeId** `string` *required*
>
> ID of the status attribute
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
