Create Note

POST 
/contacts/:contactId/notes

Create Note

Request

Version stringrequired

API Version

Available optionsv3

contactId stringrequired

Contact Id

application/json

application/json

Body

Bodyrequired

userIdstring

User Id of the note author

bodystringrequired

Body content of the note

titlestring

Title of the note

colorstring

Hex color code for the note

pinnedboolean

Whether the note is pinned

Example (auto)

{
  "userId": "GCs5KuzPqTls7vWclkEV",
  "body": "lorem ipsum",
  "title": "Follow-up summary",
  "color": "#FFAA00",
  "pinned": false
}

application/json

Successful response

application/json

Schema

Schema

noteobject

Note details

Example (auto)

{
  "note": {
    "id": "HGPcayliwcdoUFzvbTok",
    "body": "lorem ipsum",
    "userId": "TUcmRxWrjqzJS8EjkxNK",
    "dateAdded": "2021-07-08T12:02:11.285Z",
    "contactId": "TUcmRxWrjqzJS8EjkxNK"
  }
}