Skip to main content
Zixflow logo
  • Category: crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 7
  • Triggers: 0
  • Slug: ZIXFLOW
  • Version: 20260615_00

Tools

Slug: ZIXFLOW_CREATE_ATTRIBUTETool 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

string
required
Human-readable display name shown in the UI. Can contain spaces and special characters
object
required
Configuration object with settings specific to the inputType. Required fields vary by inputType (e.g., currency requires currencyCode)
string ("collection" | "list")
required
Type specification: either ‘collection’ or ‘list’ where the attribute will be created
boolean
Whether this attribute’s value must be unique across all records in the target. Useful for identifiers like email or account ID
string
required
Unique identifier (MongoDB ObjectId format) for the target collection or list
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
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’)
boolean
Whether users can modify this attribute’s value after creation. Set to False for system-managed fields
boolean
Whether this attribute must have a value when creating new records. Required fields prevent record creation if empty
string
Detailed description of the attribute’s purpose and usage, visible to users
string
Default value assigned to this attribute when creating new records. Format depends on inputType

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZIXFLOW_GET_CAMPAIGN_REPORT_WHATSAPPTool 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

string
required
The message ID received when sending the WhatsApp campaign

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZIXFLOW_GET_EMAIL_REPORTTool 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZIXFLOW_GET_SMS_REPORTTool 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

string
required
The message ID that you received when sending the campaign

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZIXFLOW_GET_WHATSAPP_TEMPLATE_VARIABLESTool 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

string
required
Unique identifier associated with the sender’s phone number
string
required
Language code for the template (e.g., ‘en’ for English, ‘es’ for Spanish)
string
required
Name of the WhatsApp template to retrieve variables for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZIXFLOW_LIST_ATTRIBUTES_OPTIONSTool 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

string ("collection" | "list")
required
Specifies the target type, which can be either ‘collection’ or ‘list.’
string
required
Unique identifier for the target (collection ID or list ID)
string
required
ID of the select or multiselect attribute

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZIXFLOW_LIST_ATTRIBUTES_STATUSTool 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

string ("collection" | "list")
required
Specifies the target type, which can be either ‘collection’ or ‘list’
string
required
Unique identifier for the target (collection ID or list ID)
string
required
ID of the status attribute

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not