WA.cr APP - API v2
  1. Comments
WA.cr APP - API v2
  • API v2 Documentation
    • Account
      • Get Account Info
      • Get Usage Statistics
      • Get Plan Limits
    • Authentication (OTP Verification)
      • Send OTP/Verification Code
      • Resend OTP
      • Verify OTP
      • Check OTP Status
      • List Authentication Templates
    • Comments
      • Get Comments
        GET
      • Add Comment
        POST
    • Contacts
      • List Contacts
      • Create Contact
      • Get Contact
      • Update Contact
      • Delete Contact
      • Batch Create Contacts
      • Batch Delete Contacts
    • Groups
      • List Groups
      • Create Group
      • Get Group
      • Update Group
      • Delete Group
      • Add Contacts to Group
      • Remove Contacts from Group
    • Messages
      • Send Text Message
      • Send Template Message
      • Send Media Message
      • Send Interactive Message
      • List Messages
      • Get Message
    • Sources
      • List Sources
      • Create Source
      • Get Source
      • Update Source
      • Delete Source
    • Statuses
      • List Statuses
      • Create Status
      • Get Status
      • Update Status
      • Delete Status
    • Templates
      • List Templates
      • Sync Templates from WhatsApp
      • Get Template
  1. Comments

Add Comment

POST
/comments/{mobile}
Add a new internal note to a contact's chat conversation.

Authentication#

All requests require a valid API token with an active tenant.

Path Parameters#

ParameterTypeRequiredDescription
mobilestringYesContact's mobile number (must match an existing chat conversation)

Request Body#

FieldTypeRequiredValidationDescription
commentstringYesMax 5000 charsThe internal note text. Supports plain text and HTML.
status_messagestringNoMax 255 charsShort label for the note. Defaults to "Internal comment".
media_urlstringNoMust be a valid URLPublicly accessible media file URL. Downloaded and stored by the module. Supports images, audio, video, documents.
message_idstringNoMax 255 charsThe WhatsApp wamid.* of this comment/note itself. Stored for external reference.
ref_message_idstringNoMax 255 charsThe WhatsApp wamid.* of the past message being replied to. Threads the note against a specific WhatsApp message.

Response Fields#

FieldTypeDescription
successbooleantrue on success
messagestring"Comment added successfully"
tenant_idintegerResolved tenant ID
interaction_idintegerChat conversation ID
sender_idstringSender phone number (tenant default WhatsApp number)
status_messagestringThe status label saved
urlstring|nullStored media filename (if media_url was provided and downloaded)
message_idstring|nullEchoed back from request
ref_message_idstring|nullEchoed back from request
chat_message_idintegerDB row ID of the newly created internal note

Error Responses#

StatusDescription
401Token missing or invalid
404Chat conversation not found for the given mobile number
422Validation failed (see errors object in response)
500Chat tables not initialized for tenant

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Path Params

Header Params

Body Params application/json

Examples

Responses

🟢201
application/json
Comment added successfully
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/comments/919876543210' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "comment": "<strong>FEES PAYMENTS | Coming Soon</strong>\nThe fee payment system is currently under development.",
    "status_message": "Sent payment request",
    "message_id": "wamid.qwertyuiop1234567890",
    "ref_message_id": "wamid.zxcvbnmasdfghjkl0987654321",
    "media_url": "https://example.com/path/to/attachment.jpg"
}'
Response Response Example
{
    "success": true,
    "message": "Comment added successfully",
    "tenant_id": 1,
    "interaction_id": 1,
    "sender_id": "912233445566",
    "status_message": "Sent payment request",
    "url": null,
    "message_id": "wamid.qwertyuiop1234567890",
    "ref_message_id": null,
    "chat_message_id": 1
}
Modified at 2026-02-25 01:06:20
Previous
Get Comments
Next
List Contacts
Built with