v1

latestOpenAPI 3.0.02026-07-2483164186.3 KB
Notes

Create Note

Create a note attached to a customer chat or a WA Group chat. Use to + from for customer chats, or groupId for WA Group chats. Rate limit: 60 requests per minute per organization.

post/notes

Request body

notestring required

Text content of the note

groupIdstring

The groupId of the WA Group. Use this instead of to/from when creating a note for a group chat.

fromstring phone

The WABA phone number with country code. Required when not using groupId.

tostring phone

The customer phone number with country code. Required when not using groupId.

Example request

{
  "note": "Spoke with customer, follow-up demo scheduled for tomorrow.",
  "groupId": "grp_AbCdEf1234",
  "from": "+919999999999",
  "to": "+919999999999",
  "entities": [
    {
      "type": "USER",
      "id": "user_mitul00000"
    }
  ]
}

Response

Note created successfully

idstring

Unique identifier of the note

notestring

Text content of the note

createdBystring

Name of the user who created the note

updatedBystring

Name of the user who last updated the note

dateCreatedstring date-time

Timestamp when the note was created

dateUpdatedstring date-time

Timestamp when the note was last updated

Example response

{
  "id": "uuid-v4",
  "note": "Spoke with customer, follow-up demo scheduled for tomorrow.",
  "createdBy": "Mitul Varshney",
  "updatedBy": "Mitul Varshney",
  "dateCreated": "2026-02-06T11:55:03.170Z",
  "dateUpdated": "2026-02-06T11:55:03.170Z"
}