Create a note

POST /api/v1/note

Headers

application/json

Body Required

  • notable_type string Required

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

  • notable_uuid string 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

  • path string

    Note path, used for note grouping

  • is_pinned boolean

    Is this note pinned to the top of any results

POST /api/v1/note
curl \
 -X POST https://api.plannrcrm.com/api/v1/note \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -d '{"notable_type":"case","notable_uuid":"3e6dd235-b218-44bb-9039-4db20a129fb0","contents":"This guy rocks.","type":"meeting","path":"gifts","is_pinned":false}'
Request examples
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json

# Payload
{
  "notable_type": "case",
  "notable_uuid": "3e6dd235-b218-44bb-9039-4db20a129fb0",
  "contents": "This guy rocks.",
  "type": "meeting",
  "path": "gifts",
  "is_pinned": false
}