Add New Notes For Specific Contact
Revision as of 11:51, 17 July 2026 by Ashley DeBon (talk | contribs) (Created page with "== Add Contact Note == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contact/{id}/contact-note === Purpose === Creates a new note for a specific co...")
Contents
Add Contact Note
Base URL
https://apimobile.callproof.com
Endpoint
/api/contact/{id}/contact-note
Purpose
Creates a new note for a specific contact. Optionally links the note to a source and can clear a related follow-up recommendation when the note is created from a recommended follow-up action.
HTTP Method
POST
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
Security
- Yes – Requires Bearer Token authentication.
Parameters
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | Yes | Unique identifier of the contact that will receive the note |
Query Parameters
None.
Request Body
| Parameter | Type | Required | Description |
|---|---|---|---|
| note | string | Yes | Note text to save |
| source_type | integer | No | Source type identifier for the note (numeric only when provided) |
| source_id | integer | No | Source record identifier related to the note (numeric only when provided) |
| recommended_followup | integer | No | When set to 1, removes the related “Add Notes” follow-up recommendation for this contact and user
|
Successful Response (200)
Indicates that the contact note was created successfully.
| Field | Type | Description |
|---|---|---|
| clientStatusCode | integer | Status indicator for the client (for example, 200) |
| user_id | integer | Identifier of the authenticated user |
| company_id | integer | Identifier of the authenticated user’s company |
| message | string | Confirmation message (for example, "Contact Note Created Successfully") |
| uri | string | Requested resource URI |
Error Responses
| Status Code | Meaning |
|---|---|
| 200 | Validation failed – response body uses clientStatusCode 401 with the first validation error message
|
| 400 | Bad Request – the note could not be created |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- Validation (HTTP 200, clientStatusCode 401) – Missing
note, or invalidsource_type/source_idformat. - 400 – An error occurred while adding the note (for example, "Error while Adding Contact Notes").
- 401 – Authentication failed or the access token is missing/expired.