# ChakraHQ APIs ## Docs - [API Keys](https://apidocs.chakrahq.com/doc-733153.md): - [Response Format](https://apidocs.chakrahq.com/doc-738798.md): - [Inbound Events Webhook](https://apidocs.chakrahq.com/doc-919167.md): - [How to figure out pluginId and whatsappPhoneNumberId](https://apidocs.chakrahq.com/doc-1395014.md): ## API Docs - Send Template Messages [Send Whatsapp Template Message For Process](https://apidocs.chakrahq.com/api-11312599.md): This API allows you to send a whatsapp template message for a process - Send Template Messages [Send Whatsapp Template Message For A Phone Number](https://apidocs.chakrahq.com/api-11312774.md): This API allows you to send a whatsapp template message for a given phone number - Send Template Messages [Send Template Message (Meta API Format)](https://apidocs.chakrahq.com/api-26944128.md): The following API allows you to invoke the whatsapp messages api directly. This API will allow you to - Send Session Messages [WhatsApp Messages API (pass-through)](https://apidocs.chakrahq.com/api-11313675.md): The following API allows you to invoke the whatsapp messages api directly. This API will allow you to - Send Session Messages [Send WhatsApp session message (pass-through)](https://apidocs.chakrahq.com/api-22547477.md): The following API allows you to send session messages. This API is technically same as the WhatsApp Messages API. This document is created to focus specifically on the payload formats for sending session messages. - Message Templates - Create & Manage [Create WhatsApp Message Template (pass-through)](https://apidocs.chakrahq.com/api-17615301.md): Create a WhatsApp message template. This is a pass through API, so the request body format and response format matches that of WhatsApp apis. Detailed documentation for this can be found [here]( https://developers.facebook.com/docs/graph-api/reference/whats-app-business-hsm/#Creating) - Message Templates - Create & Manage [List WhatsApp Message Templates (pass-through)](https://apidocs.chakrahq.com/api-17615391.md): List WhatsApp message templates. This is a pass through API, so the request body format and response format matches that of WhatsApp apis. - Message Templates - Create & Manage [Update WhatsApp Message Template (pass-through)](https://apidocs.chakrahq.com/api-17615603.md): Update an existing WhatsApp message template. This is a pass through API, so the request body format and response format matches that of WhatsApp apis. Detailed documentation for this can be found [here]( https://developers.facebook.com/docs/graph-api/reference/whats-app-business-hsm/#Updating) - Media - Upload & Manage [Upload Public Media](https://apidocs.chakrahq.com/api-11313630.md): This API allows you to upload a media file like a photo or a video to chakra. This is useful to host your files to be accepte by whatsapp apis while sending whatsapp template messages. - Media - Upload & Manage [Show Whatsapp Media API](https://apidocs.chakrahq.com/api-20534488.md): The following API allows you to directly download/show the media against a mediaId - Media - Upload & Manage [Fetch Whatsapp Media API](https://apidocs.chakrahq.com/api-20534427.md): The following API allows you to fetch the media object associated to a WhatsApp media id. - Media - Upload & Manage [Show Whatsapp Media Attachments API](https://apidocs.chakrahq.com/api-20534563.md): The following API allows you to directly download/show the media against a mediaId - Flows - Create & Manage [Set Business Public Key](https://apidocs.chakrahq.com/api-26919938.md): In order to decrypt and encrypt data passed through WhatsApp Flows, every WhatsApp Business Account (WABA) requires a key pair, which needs to be signed for every phone number sending Flows within the WABA. - Flows - Create & Manage [Get Business Public Key](https://apidocs.chakrahq.com/api-26920714.md): In order to decrypt and encrypt data passed through WhatsApp Flows, every WhatsApp Business Account (WABA) requires a key pair, which needs to be signed for every phone number sending Flows within the WABA. - Leads - Create & Manage [Create a lead](https://apidocs.chakrahq.com/api-21235605.md): Use this api to create a lead. Be sure that your team has a lead module before using this API. - Chat & Chat Messages [List chats](https://apidocs.chakrahq.com/api-23827369.md): This API allows you to list chat sessions for your team - Chat & Chat Messages [List chat messages for a chat](https://apidocs.chakrahq.com/api-23827415.md): List all chat messages for a given chat - Chat & Chat Messages [List previous messages for a phone number](https://apidocs.chakrahq.com/api-22749108.md): This API allows you to list chat messages exchanged with a customer phone number. In response you - Campaigns - Manage [Add a phone number to a lead campaign](https://apidocs.chakrahq.com/api-27595176.md): This API allows you to add a phone number to an existing WhatsApp campaign. If there is a lead existing by the given phone number, the same will be used. Else a new lead will be created. - Partner Access [Create Connect Token](https://apidocs.chakrahq.com/api-28220708.md): If you want to enable your customers to connect their WhatsApp phone numbers via your Chakra Account, you will need to generate a connect token first. - Platform > Process [Fetch Process By Id](https://apidocs.chakrahq.com/api-11375429.md): This API allow you to fetch a single process. Examples of a process are models like: Lead, Ticket, FieldVisit. - Platform > Process [List Processes](https://apidocs.chakrahq.com/api-11375466.md): This API allow you to query and list processes. Examples of a process are models like: Lead, Ticket, FieldVisit. - Platform > Process [Create Process](https://apidocs.chakrahq.com/api-11530135.md): This API allow you to create a single process. Examples of a process are models like Lead, Ticket and Fieldvisit - Platform > Process [Update Process](https://apidocs.chakrahq.com/api-11530500.md): This API allow you to update a single process. A process can be updated basis its chakra process id. - Platform > Process [Update Process By Primary Key](https://apidocs.chakrahq.com/api-11530504.md): This API allow you to update a single process. A process can be updated basis its primaryKey value. - Platform > Process [Delete Process](https://apidocs.chakrahq.com/api-11530634.md): This API allows you to delete a single process. A process can be deleted basis its chakra process id. - Platform > Process [Delete Process By Primary Key Value](https://apidocs.chakrahq.com/api-11530665.md): This API allows you to delete a single process. A process can be deleted basis its primary key value. - Platform > Process [Bulk Create Process API](https://apidocs.chakrahq.com/api-11531004.md): This API allows you to create multiple processes in a single API call. This API is asynchronous - meaning the request is accepted and an acknowledgment is returned while the creates are carried out in the background. Use this API when you have to update 1000s of processes in one go. - Platform > Process [Bulk Update Process API](https://apidocs.chakrahq.com/api-11531082.md): The following API allows you to update multiple processes in a single API call. This API is asynchronous - meaning the request is accepted and an acknowledgment is returned while the updates are carried out in the background. Use this api when you have to update 1000s of processes in one go. - Platform > Task [Create Task API](https://apidocs.chakrahq.com/api-11531119.md): The following API allow you to creat a task for a process. - Platform > User [List Users API](https://apidocs.chakrahq.com/api-11531149.md): The following API allows you to fetch all users of your team - Platform > User [List Users API (V2)](https://apidocs.chakrahq.com/api-11531150.md): The following API allows you to fetch all users of your team - Platform > User [Fetch User API](https://apidocs.chakrahq.com/api-11531158.md): The following API allows you to fetch a single user. - Platform > User [Fetch User API (V2)](https://apidocs.chakrahq.com/api-11531166.md): - Platform > User [Update User API](https://apidocs.chakrahq.com/api-11531186.md): The following API allows you to update a single user. - Platform > Photo [Fetch Photo API](https://apidocs.chakrahq.com/api-11531249.md): The following API allow you to fetch a single photo given a photo id. - Platform > Photo [Upload Photo API](https://apidocs.chakrahq.com/api-11531275.md): The following API allow you to upload a single photo and generate a photo object. - Platform > Photo [Upload Photo API With Id](https://apidocs.chakrahq.com/api-11531276.md): The following API allow you to upload a single photo and generate a photo object. - Platform > Background Job [Fetch Background Job](https://apidocs.chakrahq.com/api-11531337.md): The Background job api gives you information about a background job that has been scheduled manually, as part of a bulk api request or through some other workflow. - Platform > Background Job [Fetch Background Job Entries API](https://apidocs.chakrahq.com/api-11531427.md): If you want to get the status of the individual entries supplied to the background job you can do so with this api - Platform [Fetch Config](https://apidocs.chakrahq.com/api-11531312.md): The following APIs give you access to the internal config. ## Schemas - Whatsapp [MappingType](https://apidocs.chakrahq.com/schema-3982502.md):