--- title: Z-API slug: z-api image: https://make-cxp-documentation.ams3.digitaloceanspaces.com/apps-center-icons/PREVIEW_z-api.png docTags: createdAt: 2025-09-16T17:26:11.011Z --- ::::VerticalSplit{layout="left"} :::VerticalSplitItem ::Image[]{src="https://app.archbee.com/api/optimize/oAyFj2GHlBeBVWF5OAir2/vmO_u4TS6bJUb2eXlZikp-20250916-193546.png" size="50" width="800" height="800" darkWidth="800" darkHeight="800" position="center" showCaption="false"} ::: :::VerticalSplitItem Z-API is an API for WhatsApp Business, allowing you to send and receive messages and manage your WhatsApp communications programmatically. With the Z-API app in Make, you can manage the messages, contacts, chats, group participants and admins, products, and queue messages in your Z-API account. ::: :::: # Requirements To use the Z-API app in Make, you must have a [Z-API account](https://app.z-api.io/app/auth/new-account). # Connect Z-API and Make To get started, you must first create a connection between Z-API and Make, allowing the two services to communicate. To create the connection, you need to: ::::WorkflowBlock :::WorkflowBlockItem [Obtain an Instance ID and Token ID in your Z-API account.](docId\:wn3RBJddJSBnvaZIIqK9c) ::: :::WorkflowBlockItem [Obtain a Client Token in your Z-API account.](docId\:wn3RBJddJSBnvaZIIqK9c) ::: :::WorkflowBlockItem [Create the connection in Make.](docId\:wn3RBJddJSBnvaZIIqK9c) ::: :::: ## Obtain your Instance ID and Token ID in Z-API Before you create the connection in Make, you should first obtain an Instande ID and Token ID in your Z-API account. To obtain the Instance ID and Token ID: ::::WorkflowBlock :::WorkflowBlockItem Log in to your Z-API account. ::: :::WorkflowBlockItem In the left sidebar, click **Web Instances**. ::: :::WorkflowBlockItem Click **+ Add**. ::: :::WorkflowBlockItem In the **Web instance** data field, enter a name for your instance. ::: :::WorkflowBlockItem Optional: In the Configure webhooks section, enter the webhooks to receive events from your instance. ::: :::WorkflowBlockItem Click **Save **to complete the creation of your instance. ::: :::WorkflowBlockItem Copy the **Instances ID** and **Instance token** values and store them in a safe place. ![](https://api.archbee.com/api/optimize/oAyFj2GHlBeBVWF5OAir2/aEAq6nLuU1KBKlXCIKqpQ_image.png) ::: :::: You'll use these values in the **Instance ID** and **Token ID** connection fields in Make. ## Obtain your Client Token Once you create your instance, you're ready to obtain your Client Token. To obtain the Client Token: ::::WorkflowBlock :::WorkflowBlockItem In the left sidebar, click **Security**. ::: :::WorkflowBlockItem In the **Account Security Token** field, click **Configure now**. ::: :::WorkflowBlockItem Select a way to confirm the creation of the client token and enter the code sent. ::: :::WorkflowBlockItem Copy the **Client Token** value and store it in a safe place. ::: :::: You'll use this value in the **Client Token** connection field in Make. ## Create the connection in Make Once you have your Z-API Instance ID, Instance Token, and Client Token, you're ready to create the connection in Make. To create the connection: ::::WorkflowBlock :::WorkflowBlockItem Log in to your Make account, add a Z-API module to your scenario, and click **Create a connection**. ::: :::WorkflowBlockItem Optional: In the ​​**Connection name​​** field, enter a name for the connection. ::: :::WorkflowBlockItem In the **Name** field, enter a name for the connection label that will be used in Z-API. ::: :::WorkflowBlockItem In the **Instance ID** field, enter the **Instance ID** value copied from your Z-API account. ::: :::WorkflowBlockItem In the **Token ID** field, enter the **Instance token** value copied from your Z-API account. ::: :::WorkflowBlockItem In the **Client Token** field, enter the **Client Token** value copied from your Z-API account. ::: :::WorkflowBlockItem Click **Save**. ::: :::WorkflowBlockItem If prompted, authenticate your account and confirm access. ::: :::: You've successfully created the connection and can now use the Z-API app in your scenarios. If you want to make changes to your connection in the future, follow the steps [here](https://help.make.com/connect-an-application#tN2pJ). # Z-API modules After connecting to the Z-API app, you can use the following types of modules to build your scenarios. :::ExpandableHeading **Contacts** - List Contacts - Get a Contact Profile Picture - Get a Contact Metadata - Contact Phone Exists ::: :::ExpandableHeading **Message** - Send a Text Message - Send PIX Button - Send an Audio - Send an Image - Send a Location - Send a Document - Send a Button List - Send a Sticker - Send a Video - Send a Link - Send a Contact - Send an Option List - Read a Message - Reply a Message - Delete a Message ::: :::ExpandableHeading **Instance** - QR Code Status - Disconnect Phone - Get Device Data ::: :::ExpandableHeading **Chat** - Archive a Chat - Delete a Chat - List Chats - Pin Chat ::: :::ExpandableHeading **Group** - Create a Group - Add a Group Participant - Remove a Group Participant - Add an Admin - Remove an Admin - Get a Group Invitation Metadata - Get a Group Metadata - Update a Group Settings - Leave a Group - Update a Group Description - Update a Group Image - Update a Group Name ::: :::ExpandableHeading **Status** - Post a Status Image - Post a Status Text ::: :::ExpandableHeading **Product** - Create/Update a Product - Delete a Product - Get a Product - Get a Product by Phone - List Products ::: :::ExpandableHeading **Queue** - Delete Queue Messages - Get a Queue Messages ::: :::ExpandableHeading **Other** - Make an API Call ::: # Templates You can look for Z-API templates in [Make's template gallery](https://www.make.com/en/templates), where you'll find thousands of pre-created scenarios. # Z-API resources - [Z-API API documentation](https://developer.z-api.io/en/)**