Add Notes to Calls

POST

https://platform-api.convirza.com/v3/conversations/calls/notes

Calls

Last modified:2026-07-24 13:10:44

Adds one or more notes (comments) to one or more calls. Notes are used to document important information, follow-up actions, or agent observations about calls.

Behavior:

Multiple notes can be added to the same call in a single request

Multiple calls can be annotated in a single request

Duplicate notes for the same call are rejected (compared case-insensitively after trimming)

Duplicate notes are also checked against existing notes from the same user

Blank or empty notes are rejected

Maximum 10,000 characters per note

Transaction Handling:

All notes are added atomically — either all notes are inserted or none are (automatic rollback on error)

This ensures data consistency when adding multiple notes across multiple calls

Authorization:
User must have access to all organizational units that own the calls being annotated.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Notes added successfully

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://platform-api.convirza.com/v3/conversations/calls/notes' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "notes": [
        {
            "call_id": 123456,
            "note": [
                "Customer was interested in product demo"
            ]
        },
        {
            "call_id": 123457,
            "note": [
                "Follow up scheduled for next week",
                "Sent pricing information"
            ]
        }
    ]
}'

Response Example

201 - Example 1

{
    "code": 200,
    "message": "Success",
    "data": {
        "message": "Notes added successfully",
        "notes_added": 3
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-01-20T12:34:56.789Z"
}

Modified at 2026-07-24 13:10:44

Move Call to Another Group

Upload Call Recording