Add New Note

POST/api/notes

Headers

FieldTypeDescription
authtoken String Authentication token, generated from admin area

Parameters

FieldTypeDescription
rel_type String Entity type the note attaches to (12 supported types).
rel_id Number The related record id.
description String Note text.
curl -X POST "https://yoursite.com/api/notes" \
  -H "authtoken: YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "rel_type": "...", "rel_id": "...", "description": "..." }'

Success-Response:

HTTP/1.1 200 OK
{
    "status": true,
    "message": "Note added successfully",
    "record_id": 143
}

Validation-Error:

HTTP/1.1 422 Unprocessable Entity
{
    "status": false,
    "error": "validation_failed",
    "message": "Note validation failed",
    "errors": {
        "rel_type": "rel_type must be one of: customer, lead, contract, ticket, invoice, estimate, credit_note, staff, expense, proposal, project, task",
        "description": "The description field is required."
    }
}
MethodPOST
Path/api/notes
GroupNotes
Sincev3.0.0
Defined inmodules/api/controllers/Notes.php