POST /api/v1/note
Personal access token & O auth2
application/json

Body

  • notable_type string Required

    The model type that the note is for. Available options are: account, bank_transaction, case, charge, check, circle, conversation, expectation, illustration, plan, risk, statement, statement_transaction, task

    Values are account, bank_transaction, case, charge, check, circle, conversation, expectation, illustration, plan, risk, statement, statement_transaction, or task.

  • notable_uuid string(uuid) Required

    The UUID of the model that the note is for.

  • contents string Required

    The note's contents.

  • type string

    Type of note. Available note types are: call, note, meeting and email

    Value Description
    call Call
    note Note
    meeting Meeting
    email Email

    Values are call, note, meeting, or email.

  • path string

    Note path, used for note grouping

  • is_pinned boolean

    Is this note pinned to the top of any results

  • visible_to_clients boolean

    Is this note visible to client accounts

Responses

  • 401 application/json
    Hide response attribute Show response attribute object
    • message string
POST /api/v1/note 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/note' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"notable_type":"account","notable_uuid":"57244b25-f84a-4e9d-bc34-ed496ff37b28","contents":"This guy rocks.","type":"call","path":"gifts","is_pinned":false,"visible_to_clients":false}'
Request examples 
{
  "notable_type": "account",
  "notable_uuid": "57244b25-f84a-4e9d-bc34-ed496ff37b28",
  "contents": "This guy rocks.",
  "type": "call",
  "path": "gifts",
  "is_pinned": false,
  "visible_to_clients": false
}
Response examples (401) 
{
  "message": "Unauthenticated."
}