Difference between revisions of "Add New Notes For Specific Contact"

From docs
Jump to: navigation, search
(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...")
 
(→‎Successful Response (200))
 
Line 47: Line 47:
 
| recommended_followup || integer || No || When set to <code>1</code>, removes the related “Add Notes” follow-up recommendation for this contact and user
 
| recommended_followup || integer || No || When set to <code>1</code>, removes the related “Add Notes” follow-up recommendation for this contact and user
 
|}
 
|}
 +
 +
=== cURL Example for Android ===
 +
<pre>
 +
curl --location --request POST 'https://apimobile.callproof.com/api/contact/{id}/contact-note' \
 +
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
 +
--form 'note=YOUR_NOTE_TEXT'
 +
</pre>
 +
=== cURL Example for iOS ===
 +
<pre>
 +
curl --location --request POST 'https://apimobile.callproof.com/api/contact/{id}/contact-note' \
 +
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
 +
--form 'note=YOUR_NOTE_TEXT'
 +
</pre>
  
 
=== Successful Response (200) ===
 
=== Successful Response (200) ===

Latest revision as of 11:52, 17 July 2026

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

cURL Example for Android

curl --location --request POST 'https://apimobile.callproof.com/api/contact/{id}/contact-note' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--form 'note=YOUR_NOTE_TEXT'

cURL Example for iOS

curl --location --request POST 'https://apimobile.callproof.com/api/contact/{id}/contact-note' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--form 'note=YOUR_NOTE_TEXT'

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 invalid source_type / source_id format.
  • 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.
Retrieved from "http://docs.callproof.com/index.php?title=Add_New_Notes_For_Specific_Contact&oldid=2258"