API:ContactNote:Update

API » Update Contact Note

Base URL

https://app.callproof.com

Endpoint

/api/contact_note/update/

Purpose

Updates the text content of an existing contact note in your CallProof company. Use this when a note needs to be corrected or revised without changing the associated contact or other note metadata.

HTTP Method

POST

Headers

Header	Required	Description
Content-Type	Yes	Must be application/json.

Security

• Yes – Requires a valid API key and secret with permission to update contact notes. Credentials are sent in the request body.

Parameters

Path Parameters

None.

Query Parameters

None.

Request Body

Parameter	Type	Required	Description
api_key	object	Yes	Authentication credentials object.
api_key.key	string	Yes	Public API key assigned to your CallProof account.
api_key.secret	string	Yes	Private API secret paired with the API key.
contact_note	object	Yes	Contact note update payload.
contact_note.id	integer	Yes	Unique identifier of the note to update. Must belong to your company.
contact_note.note	string	No	Updated note text. Maximum 4,096 characters. If omitted, the note text is cleared.

cURL Example

curl -X POST "https://app.callproof.com/api/contact_note/update/" \
  -H "Content-Type: application/json" \
  -d '{
    "api_key": {
      "key": "YOUR_API_KEY",
      "secret": "YOUR_API_SECRET"
    },
    "contact_note": {
      "id": 1001,
      "note": "Updated follow-up notes after the meeting."
    }
  }'

Successful Response (200)

Indicates the note was successfully updated. The response returns the updated note details.

Field	Type	Description
results	object	Updated contact note details.
results.id	integer	Unique identifier for the note.
results.created	string	Date and time the note was created (YYYY-MM-DD HH:MM:SS).
results.created_by_id	integer	User ID of the person who created the note.
results.created_by_email	string	Email address of the person who created the note.
results.created_by	string	Display name of the person who created the note.
results.contact_id	integer	Identifier of the contact associated with the note.
results.contact	string	Display name of the associated contact.
results.company_id	integer	Identifier of the company associated with the contact.
results.company	string	Company name associated with the contact.
results.note	string	Updated text content of the note.
errors	array	Empty list when the request succeeds.
code	integer	HTTP-style status value; 200 on success.

Example response:

{
  "results": {
    "id": 1001,
    "created": "2024-06-15 14:30:00",
    "created_by_id": 456,
    "created_by_email": "rep@example.com",
    "created_by": "Jane Smith",
    "contact_id": 789,
    "contact": "John Doe",
    "company_id": 321,
    "company": "Acme Corp",
    "note": "Updated follow-up notes after the meeting."
  },
  "errors": [],
  "code": 200
}

Notes

• The id parameter is the note ID, not the contact ID.
• The note must belong to your company.
• Only the note text is updated. Creator, contact association, and creation date are not changed.
• If note is omitted, the note text is cleared to an empty value.
• Note text is limited to 4,096 characters.

Error Responses

Status Code	Meaning
400	Bad Request – The note ID is missing, invalid, or does not match a note in your company.
401	Unauthorized – The API key and/or secret is missing, invalid, inactive, associated with a disabled account, or lacks permission to update contact notes.
405	Method Not Allowed – A method other than POST was used.
500	Internal Server Error – An unexpected server problem occurred. Not specified in Swagger.

400 response body example:

{
  "results": [],
  "errors": ["Invalid 'id' field"],
  "code": 400
}

401 response body example:

{
  "results": [],
  "errors": ["Invalid API Key"],
  "code": 401
}

405 response body example:

{
  "results": [],
  "errors": ["Method not allowed"],
  "code": 405
}