# Zixflow Docs

> Zixflow API Documentation - Complete guide for integrating with Zixflow's API services including Zixflow App and Zixflow AI

## Docs

- [Create An Activity](https://docs.zixflow.com/api-reference/activity-list/create.md): This endpoint creates an activity or task within a collection.
- [Delete Activity By ID](https://docs.zixflow.com/api-reference/activity-list/delete.md): This endpoint allows the deletion of selected activity details.
- [Update An Activity](https://docs.zixflow.com/api-reference/activity-list/edit.md): This endpoint updates an existing activity or task within a collection.
- [Get List of Activities](https://docs.zixflow.com/api-reference/activity-list/get.md): This endpoint returns all activity data
- [Get Activity By Id](https://docs.zixflow.com/api-reference/activity-list/get-by-id.md): This endpoint returns all activity data
- [Create Custom Attribute](https://docs.zixflow.com/api-reference/attributes/create.md): This endpoint creates a new attribute for a specified target (collection or list).
- [Delete Custom Attribute](https://docs.zixflow.com/api-reference/attributes/delete.md): This endpoint allows the deletion of a custom attribute.
- [Get Attribute By ID](https://docs.zixflow.com/api-reference/attributes/get.md): This endpoint retrieves the details of a specific attribute by ID.
- [Get List Of Attributes](https://docs.zixflow.com/api-reference/attributes/get-list-of-attributes.md): This endpoint retrieves the list of attributes associated with a collection or list.
- [Delete Attribute Option](https://docs.zixflow.com/api-reference/attributes/options/delete.md): This endpoint allows the deletion of a option within a select/multiselect attribute.
- [Get List Of Attribute Options](https://docs.zixflow.com/api-reference/attributes/options/get.md): This endpoint retrieves the list of options for select/multiselect attributes.
- [Update Attribute Option](https://docs.zixflow.com/api-reference/attributes/options/update.md): This endpoint updates a select/multiselect attribute option.
- [Delete Attribute Status Option](https://docs.zixflow.com/api-reference/attributes/statuses/delete.md): This endpoint allows the deletion of a status option within a status attribute.
- [Get List Of Attribute Status Options](https://docs.zixflow.com/api-reference/attributes/statuses/get.md): This endpoint retrieves the list of options for status attributes.
- [Update Attribute Status Option](https://docs.zixflow.com/api-reference/attributes/statuses/update.md): This endpoint updates a status attribute option.
- [Update Custom Attribute](https://docs.zixflow.com/api-reference/attributes/update.md): This endpoint updates an existing attribute for a specified target (collection or list).
- [API Key Authentication](https://docs.zixflow.com/api-reference/authentication.md): 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.
- [Introduction](https://docs.zixflow.com/api-reference/campaign/email/introduction.md): Campaign - Send Email
- [Send Email](https://docs.zixflow.com/api-reference/campaign/email/send-email.md): This endpoint allows you to send an email.
- [Upload Attachment](https://docs.zixflow.com/api-reference/campaign/email/upload-attachment.md): 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 attachm…
- [OTPflow API](https://docs.zixflow.com/api-reference/campaign/otp-flow/otp-flow-api.md): AI-powered OTPflow API designed to maximize message delivery success by automatically routing messages through multiple channels on autopilot.
- [Get List of Template Variables](https://docs.zixflow.com/api-reference/campaign/rcs/get-template-variables.md): Retrieve the variable details for a specific RCS template.
- [Incoming Message Webhook](https://docs.zixflow.com/api-reference/campaign/rcs/incoming-message-webhook.md)
- [Introduction to RCS Messaging](https://docs.zixflow.com/api-reference/campaign/rcs/introduction.md)
- [Send Audio Message](https://docs.zixflow.com/api-reference/campaign/rcs/messages/audio-message.md)
- [Send Document Message](https://docs.zixflow.com/api-reference/campaign/rcs/messages/document-message.md)
- [Send Image Message](https://docs.zixflow.com/api-reference/campaign/rcs/messages/image-message.md)
- [Send Text Message](https://docs.zixflow.com/api-reference/campaign/rcs/messages/text-message.md)
- [Send Video Message](https://docs.zixflow.com/api-reference/campaign/rcs/messages/video-message.md)
- [Send Template Message](https://docs.zixflow.com/api-reference/campaign/rcs/send-rcs-template.md)
- [Get Email Message Report](https://docs.zixflow.com/api-reference/campaign/report/get-email-report.md)
- [Get SMS Message Report](https://docs.zixflow.com/api-reference/campaign/report/get-sms-report.md)
- [Get Whatsapp Message Report](https://docs.zixflow.com/api-reference/campaign/report/get-whatsapp-report.md)
- [Introduction](https://docs.zixflow.com/api-reference/campaign/sms/introduction.md): Campaign - Send SMS
- [Send SMS](https://docs.zixflow.com/api-reference/campaign/sms/send-sms-get.md): 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](https://docs.zixflow.com/api-reference/campaign/sms/send-sms-post.md)
- [Get List Of Templates](https://docs.zixflow.com/api-reference/campaign/whatsapp/get-template-list.md)
- [Get List Of WA Accounts](https://docs.zixflow.com/api-reference/campaign/whatsapp/get-whatsapp-accounts.md)
- [Incoming Message Webhook](https://docs.zixflow.com/api-reference/campaign/whatsapp/incoming-message-webhook.md)
- [Introduction](https://docs.zixflow.com/api-reference/campaign/whatsapp/introduction.md): Campaign - Send Whatsapp
- [Send Whatsapp Audio Message](https://docs.zixflow.com/api-reference/campaign/whatsapp/messages/audio-message.md)
- [Send Whatsapp Document Message](https://docs.zixflow.com/api-reference/campaign/whatsapp/messages/document-message.md)
- [Send Whatsapp Image Message](https://docs.zixflow.com/api-reference/campaign/whatsapp/messages/image-message.md)
- [Send Whatsapp Location Message](https://docs.zixflow.com/api-reference/campaign/whatsapp/messages/location-message.md)
- [Send Whatsapp Text Message](https://docs.zixflow.com/api-reference/campaign/whatsapp/messages/text-messages.md)
- [Send Whatsapp Video Message](https://docs.zixflow.com/api-reference/campaign/whatsapp/messages/video-message.md)
- [Send Whatsapp Template Message](https://docs.zixflow.com/api-reference/campaign/whatsapp/send-whatsapp-message.md)
- [Get Template Variables](https://docs.zixflow.com/api-reference/campaign/whatsapp/template-variable-get.md)
- [Authentication Templates](https://docs.zixflow.com/api-reference/campaign/whatsapp/whatsapp-auth-template.md)
- [Get Collection By ID](https://docs.zixflow.com/api-reference/collection/get-collection.md): This endpoint returns a collection
- [Get List Of Collections](https://docs.zixflow.com/api-reference/collection/get-list-of-collections.md): Lists all system and custom collections of your workspace.
- [Introduction to Collections](https://docs.zixflow.com/api-reference/collection/introduction.md)
- [Filtering And Sorting](https://docs.zixflow.com/api-reference/filtering-and-sorting.md)
- [Introduction](https://docs.zixflow.com/api-reference/introduction.md)
- [Create A List Entry](https://docs.zixflow.com/api-reference/list-entries/create.md): This endpoint creates a new entry in the specified list.
- [Delete List Entry By ID](https://docs.zixflow.com/api-reference/list-entries/delete.md): This endpoint allows the deletion of a selected list entry.
- [Update List Entry](https://docs.zixflow.com/api-reference/list-entries/edit.md): This endpoint updates an existing entry in the specified list.
- [Get List of List Entries](https://docs.zixflow.com/api-reference/list-entries/get.md): This endpoint returns all entry data of selected list
- [Get List Entry By ID](https://docs.zixflow.com/api-reference/list-entries/get-by-id.md): This endpoint returns selected list entry data
- [Get List By ID](https://docs.zixflow.com/api-reference/list/get-list.md): This endpoint returns a list
- [Get List of Lists](https://docs.zixflow.com/api-reference/list/get-list-of-lists.md): This endpoint returns all lists
- [Create A Collection Record](https://docs.zixflow.com/api-reference/records/create.md): This endpoint creates a new collection record in the specified collection.
- [Delete Collection Record By ID](https://docs.zixflow.com/api-reference/records/delete.md): This endpoint allows the deletion of a selected collection record.
- [Update A Collection Record](https://docs.zixflow.com/api-reference/records/edit.md): This endpoint updates an existing collection record in the specified collection.
- [Get List of Collection Records](https://docs.zixflow.com/api-reference/records/get.md): This endpoint returns all records data of selected collection
- [Get Collection Record By ID](https://docs.zixflow.com/api-reference/records/get-by-id.md): This endpoint returns selected collection record data
- [Get Workspace Member By ID](https://docs.zixflow.com/api-reference/workspace-members/get.md): This endpoint returns selected worksapce member data
- [Get List of Workspace Members](https://docs.zixflow.com/api-reference/workspace-members/get-list-of-members.md): This endpoint returns all worksapce member details
- [API Authentication](https://docs.zixflow.com/api-reference/zixflow-ai/authentication.md): Authenticate Zixflow AI API requests using x-api-key and x-workspace-id
- [Send Email Message](https://docs.zixflow.com/api-reference/zixflow-ai/email/send-message.md): Send an email message to a recipient
- [Send Email Template](https://docs.zixflow.com/api-reference/zixflow-ai/email/send-template.md): Send an email using a predefined template
- [Error Codes](https://docs.zixflow.com/api-reference/zixflow-ai/error-codes.md): Reference for error codes returned by the Zixflow AI API
- [Introduction](https://docs.zixflow.com/api-reference/zixflow-ai/introduction.md): API Ingestion Service for SMS, WhatsApp, RCS, Email, and Sendflow
- [Get Message Delivery Report](https://docs.zixflow.com/api-reference/zixflow-ai/messages/get-delivery-report.md): Retrieves a single message delivery report by request_id
- [Postback Notifications](https://docs.zixflow.com/api-reference/zixflow-ai/postback-notifications.md): Postback payload format for delivery status notifications across SMS, RCS, WhatsApp, and Email
- [Get RCS Template Variables](https://docs.zixflow.com/api-reference/zixflow-ai/rcs/get-template-variables.md): Retrieves the variable keys and types for a specific RCS template
- [Introduction to RCS Messaging](https://docs.zixflow.com/api-reference/zixflow-ai/rcs/introduction.md): Rich Communication Services messaging API
- [Send RCS Audio Message](https://docs.zixflow.com/api-reference/zixflow-ai/rcs/messages/audio-message.md): Send an audio message via RCS
- [Send RCS Document Message](https://docs.zixflow.com/api-reference/zixflow-ai/rcs/messages/document-message.md): Send a document message via RCS
- [Send RCS Image Message](https://docs.zixflow.com/api-reference/zixflow-ai/rcs/messages/image-message.md): Send an image message via RCS
- [Send RCS Text Message](https://docs.zixflow.com/api-reference/zixflow-ai/rcs/messages/text-message.md): Send a text message via RCS
- [Send RCS Video Message](https://docs.zixflow.com/api-reference/zixflow-ai/rcs/messages/video-message.md): Send a video message via RCS
- [Send RCS Template](https://docs.zixflow.com/api-reference/zixflow-ai/rcs/send-template.md): Send an RCS message using a predefined template
- [Condition Node](https://docs.zixflow.com/api-reference/zixflow-ai/sendflow/condition-node.md): How to use the Condition Node in Sendflow to route data based on rules
- [Get Sendflow Delivery Report](https://docs.zixflow.com/api-reference/zixflow-ai/sendflow/get-delivery-report.md): Retrieves a single Sendflow delivery report by request_id
- [Introduction to Sendflow](https://docs.zixflow.com/api-reference/zixflow-ai/sendflow/introduction.md): AI-powered Sendflow API designed to maximize message delivery success by automatically routing messages through multiple channels on autopilot
- [Stop Sendflow Execution](https://docs.zixflow.com/api-reference/zixflow-ai/sendflow/stop.md): Stop a running Sendflow workflow execution
- [Trigger Sendflow](https://docs.zixflow.com/api-reference/zixflow-ai/sendflow/trigger.md): Trigger a Sendflow automation workflow
- [Send SMS Message](https://docs.zixflow.com/api-reference/zixflow-ai/sms/send-message.md): Send an SMS message to a recipient
- [Get WhatsApp Accounts](https://docs.zixflow.com/api-reference/zixflow-ai/whatsapp/get-accounts.md): Retrieves a list of all WhatsApp accounts for the authenticated workspace
- [Get WhatsApp Template Variables](https://docs.zixflow.com/api-reference/zixflow-ai/whatsapp/get-template-variables.md): Retrieves the variable keys and types for a specific WhatsApp template
- [Get WhatsApp Templates](https://docs.zixflow.com/api-reference/zixflow-ai/whatsapp/get-templates.md): Retrieves a list of WhatsApp templates for a specific phone ID
- [Introduction to WhatsApp Messaging](https://docs.zixflow.com/api-reference/zixflow-ai/whatsapp/introduction.md): WhatsApp Business API messaging
- [Send WhatsApp Audio Message](https://docs.zixflow.com/api-reference/zixflow-ai/whatsapp/messages/audio-message.md): Send an audio message via WhatsApp
- [Send WhatsApp Contact Message](https://docs.zixflow.com/api-reference/zixflow-ai/whatsapp/messages/contact-message.md): Send a contact card (vCard) message via WhatsApp
- [Send WhatsApp Document Message](https://docs.zixflow.com/api-reference/zixflow-ai/whatsapp/messages/document-message.md): Send a document message via WhatsApp
- [Send WhatsApp Image Message](https://docs.zixflow.com/api-reference/zixflow-ai/whatsapp/messages/image-message.md): Send an image message via WhatsApp
- [Send WhatsApp Interactive Address Message](https://docs.zixflow.com/api-reference/zixflow-ai/whatsapp/messages/interactive-address-message.md): Send an interactive address message via WhatsApp
- [Send WhatsApp Interactive List Buttons Message](https://docs.zixflow.com/api-reference/zixflow-ai/whatsapp/messages/interactive-list-buttons-message.md): Send an interactive list buttons message via WhatsApp
- [Send WhatsApp Interactive Location Request Message](https://docs.zixflow.com/api-reference/zixflow-ai/whatsapp/messages/interactive-location-request-message.md): Send an interactive location request message via WhatsApp
- [Send WhatsApp Interactive Media Carousel Message](https://docs.zixflow.com/api-reference/zixflow-ai/whatsapp/messages/interactive-media-carousel-message.md): Send an interactive media carousel message via WhatsApp
- [Send WhatsApp Interactive Product Carousel Message](https://docs.zixflow.com/api-reference/zixflow-ai/whatsapp/messages/interactive-product-carousel-message.md): Send an interactive product carousel message via WhatsApp
- [Send WhatsApp Interactive Reply Buttons Message](https://docs.zixflow.com/api-reference/zixflow-ai/whatsapp/messages/interactive-reply-buttons-message.md): Send an interactive reply buttons message via WhatsApp
- [Send WhatsApp Interactive URL Button Message](https://docs.zixflow.com/api-reference/zixflow-ai/whatsapp/messages/interactive-url-button-message.md): Send an interactive URL button message via WhatsApp
- [Send WhatsApp Location Message](https://docs.zixflow.com/api-reference/zixflow-ai/whatsapp/messages/location-message.md): Send a location message via WhatsApp
- [Send WhatsApp Reaction Message](https://docs.zixflow.com/api-reference/zixflow-ai/whatsapp/messages/reaction-message.md): Send a reaction message via WhatsApp
- [Send WhatsApp Sticker Message](https://docs.zixflow.com/api-reference/zixflow-ai/whatsapp/messages/sticker-message.md): Send a sticker message via WhatsApp
- [Send WhatsApp Text Message](https://docs.zixflow.com/api-reference/zixflow-ai/whatsapp/messages/text-message.md): Send a text message via WhatsApp
- [Send WhatsApp Video Message](https://docs.zixflow.com/api-reference/zixflow-ai/whatsapp/messages/video-message.md): Send a video message via WhatsApp
- [Send WhatsApp Template](https://docs.zixflow.com/api-reference/zixflow-ai/whatsapp/send-template.md): Send a WhatsApp message using a predefined template
- [Authentication Templates](https://docs.zixflow.com/api-reference/zixflow-ai/whatsapp/whatsapp-auth-template.md)

## OpenAPI Specs

- [settings](https://docs.zixflow.com/.vscode/settings.json)

## Optional

- [Zixflow Web](https://zixflow.com/)
- [Help Center](https://help.zixflow.com/en)
- [Blog](https://zixflow.com/blog)