v1

latestOpenAPI 3.0.32026-07-26870417.2 KB

note

Send Private Notes

This endpoint is used to send private notes to a chat.

A private note is only visible on Periskope and not sent to a chat on WhatsApp.
When a user is mentioned in body of a private note using @<email>, a task is automatically created and assigned to that member.

Response

The response is a JSON note object. Refer to the note object here

post/note/create

Headers

x-phonestring

Example:{{orgPhone}}

Please provide the number of the phone you want to call with this API in the header. The number must be in country code + number format without any characters or spaces, e.g. 919876543210; Alternatively, provide the phone_id (phone-xxxxxxxxxxxx) in the header

Request body

chat_idstring required

For groups, enter the chat_id of the group. This will be a string that ends with @g.us
For 1-1 chats, enter the country_code + number of the recipient e.g. 919537851844@c.us (The @c.us is optional)

messagestring

The text body or caption. You can use basic markdown formatting supported by WhatsApp e.g. * for bold, and _ for italic, etc

reply_tostring

To reply to a message, add the WA message_id or private note message_id in this field

Example request

{
  "chat_id": "919537851844@c.us"
}

Response

Text Note / Media Note / Reply Note

object required

The response is a JSON object with the following properties:

success: Status of the request
data: A object of private note created. Refer to the private note object here