Specifies the language for the message, e.g., “en” for English.

This is the unique identifier associated with the sender’s phone number given
by WhatsApp. Find the Phone ID on the Zixflow WhatsApp Settings page next to
the number. 

Refers to the name of the template to be used for the message, e.g.,
“welcome_message.”

Bearer authentication header of the form `Bearer <token>`, where `<token>` is your auth token.

Bearer Auth

Get Template Variables

Query Params

Response

Zixflow Web

Help Center

Blog

Zixflow Docs

Dashboard

Support

Introduction

API Key Authentication is a straightforward method for securing access to the Zixflow API's. You can generate an API key through Zixflow's dashboard, allowing you to define permissions, set expiration dates, and specify IP restrictions if necessary.

API Key Authentication

Get List Of WA Accounts

Get List Of Templates

Send Whatsapp Template Message

Send Whatsapp Text Message

Send Whatsapp Image Message

Send Whatsapp Video Message

Send Whatsapp Audio Message

Send Whatsapp Document Message

Send Whatsapp Location Message

Authentication Templates

Introduction to RCS Messaging

Retrieve the variable details for a specific RCS template.

Get List of Template Variables

Send Template Message

Send Text Message

Send Image Message

Send Video Message

Send Audio Message

Send Document Message

To make it simple, We have designed a method which allows you to send SMS in a single line of the HTTP GET request

Send SMS

This endpoint allows you to send an email.

Send Email

This API used to upload attachments in zixflow platform. Purpose of API is whenever the user wants to send an attachment in the email. user need to upload attachment in zixflow platform first. zixflow will provide id represents to attachment. and the user can send this id in send email API's attachment field to send attachment along with the email

Upload Attachment

Get Whatsapp Message Report

Get SMS Message Report

Get Email Message Report

Introduction to Collections

Lists all system and custom collections of your workspace.

Get List Of Collections

Get Collection By ID

Get List of Lists

Get List By ID

This endpoint retrieves the list of options for select/multiselect attributes.

Get List Of Attribute Options

This endpoint updates a select/multiselect attribute option.

Update Attribute Option

This endpoint allows the deletion of a option within a select/multiselect attribute.

Delete Attribute Option

This endpoint retrieves the list of options for status attributes.

Get List Of Attribute Status Options

This endpoint updates a status attribute option.

Update Attribute Status Option

This endpoint allows the deletion of a status option within a status attribute.

Delete Attribute Status Option

This endpoint retrieves the list of attributes associated with a collection or list.

Get List Of Attributes

This endpoint retrieves the details of a specific attribute by ID.

Get Attribute By ID

This endpoint creates a new attribute for a specified target (collection or list).

Create Custom Attribute

This endpoint updates an existing attribute for a specified target (collection or list).

Update Custom Attribute

This endpoint allows the deletion of a custom attribute.

Delete Custom Attribute

Filtering And Sorting

This endpoint returns all records data of selected collection

Get List of Collection Records

This endpoint returns selected collection record data

Get Collection Record By ID

This endpoint creates a new collection record in the specified collection.

Create A Collection Record

This endpoint updates an existing collection record in the specified collection.

Update A Collection Record

This endpoint allows the deletion of a selected collection record.

Delete Collection Record By ID

This endpoint returns all entry data of selected list

Get List of List Entries

This endpoint returns selected list entry data

Get List Entry By ID

This endpoint creates a new entry in the specified list.

Create A List Entry

This endpoint updates an existing entry in the specified list.

Update List Entry

This endpoint allows the deletion of a selected list entry.

Delete List Entry By ID

Get List of Activities

Get Activity By Id

This endpoint creates an activity or task within a collection.

Create An Activity

This endpoint updates an existing activity or task within a collection.

Update An Activity

This endpoint allows the deletion of selected activity details.

Delete Activity By ID

This endpoint returns all worksapce member details

Get List of Workspace Members

This endpoint returns selected worksapce member data

type	sample value
IMAGE_URL	`<image-url>`
VIDEO_URL	`<video-url>`
DOCUMENT_URL	`<document-url>`
TEXT	`<text>`
OTP	`<otp>`

API Documentation

Whatsapp Campaign

RCS Campaign

SMS Campaign

Email Campaign

Campaign Report

Collections

Lists

Attributes

Collection Records

List Entries

Activity / Task

Workspace Members

Get Template Variables

Query Params

Response

API Documentation

Whatsapp Campaign

RCS Campaign

SMS Campaign

Email Campaign

Campaign Report

Collections

Lists

Attributes

Collection Records

List Entries

Activity / Task

Workspace Members

​Query Params

​Response

Query Params

Response