Communication
Z-API
12 min
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 {{product name}} , you must have a z api account connect z api and {{product name}} to get started, you must first create a connection between z api and {{product name}} , allowing the two services to communicate to create the connection, you need to z api /#obtain your instance id and token id in z api z api /#obtain your client token z api /#create the connection in obtain your instance id and token id in z api before you create the connection in {{product name}} , you should first obtain an instande id and token id in your z api account to obtain the instance id and token id log in to your z api account in the left sidebar, click web instances click + add in the web instance data field, enter a name for your instance optional in the configure webhooks section, enter the webhooks to receive events from your instance click save to complete the creation of your instance copy the instances id and instance token values and store them in a safe place you'll use these values in the instance id and token id connection fields in {{product name}} obtain your client token once you create your instance, you're ready to obtain your client token to obtain the client token in the left sidebar, click security in the account security token field, click configure now select a way to confirm the creation of the client token and enter the code sent copy the client token value and store it in a safe place you'll use this value in the client token connection field in {{product name}} create the connection in {{product name}} once you have your z api instance id, instance token, and client token, you're ready to create the connection in {{product name}} to create the connection log in to your {{product name}} account, add a z api module to your {{scenario singular lowercase}} , and click create a connection optional in the connection name field, enter a name for the connection in the name field, enter a name for the connection label that will be used in z api in the instance id field, enter the instance id value copied from your z api account in the token id field, enter the instance token value copied from your z api account in the client token field, enter the client token value copied from your z api account click save if prompted, authenticate your account and confirm access you've successfully created the connection and can now use the z api app in your {{scenario plural lowercase}} 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 {{scenario plural lowercase}} contacts list contacts get a contact profile picture get a contact metadata contact phone exists 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 instance qr code status disconnect phone get device data chat archive a chat delete a chat list chats pin chat 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 status post a status image post a status text product create/update a product delete a product get a product get a product by phone list products queue delete queue messages get a queue messages other make an api call templates you can look for z api templates in make's template gallery , where you'll find thousands of pre created {{scenario plural lowercase}} z api resources z api api documentation