Sign Up and Get Started Today

Notes

  1. /notes/save

Notes can be viewed as a list using the /timeline actions for Organisations, People, Opportunities, and Activities.

/notes/save

POST requests to /notes/save with the body of the HTTP request containing correctly formatted JSON will save a new Note, or edit an existing one if a valid ID is supplied. The Content-type of the request should be application/json.

Request

POST /notes/save/?api_token=your_token_here HTTP/1.1
Host: sample.tactilecrm.com
User-agent: Zend_Http_client (Tactile_Api::v1.0.0)
Content-type: application/json

{
   "Note":{
      "id":null,
      "title":"Note Summary",
      "note":"The body of the Note",
      "organisation_id":2,
      "person_id":null,
      "opportunity_id":null,
      "activity_id":null,
      "private":false
   }
}
id Provide the ID of an existing Note to edit it. Number.
title Required. String. Note summary.
note Required. String. Note body.
organisation_id Optional. Number. ID of an Organisation to link this Note to.
person_id Optional. Number. ID of an Person to link this Note to.
opportunity_id Optional. Number. ID of an Opportunity to link this Note to.
activity_id Optional. Number. ID of an Activity to link this Note to.
private Optional. Boolean. Defaults to false.

Response

{
   "status":"success",
   "id":123
}
status Will be 'success' or 'error'.
messages If status='error', then messages will contain an array of error messages (as strings).
id If status='success', then id will contain the id of the Note saved.