Update Note Relations

PUT 
/notes/:id/relations

Update Note Relations

Request

Version stringrequired

API Version

Available options2021-07-28

id stringrequired

Note Id

locationId stringrequired

Location Id

application/json

application/json

Body

Bodyrequired

typestringrequired

The type of relation update operation

relationsobject[]required

List of relations to add or remove — each names an object and a record id.

Example (auto)

{
  "type": "add",
  "relations": [
    {
      "objectKey": "custom_objects.pet",
      "recordId": "632c34b4c9b7da3358ac9891"
    }
  ]
}

application/json

Successful response

application/json

Schema

Schema

noteobject

The note object

Example (auto)

{
  "note": {
    "id": "HGPcayliwcdoUFzvbTok",
    "body": "lorem ipsum",
    "userId": "TUcmRxWrjqzJS8EjkxNK",
    "dateAdded": "2021-07-08T12:02:11.285Z",
    "title": "Follow-up summary",
    "color": "#FFAA00",
    "pinned": false
  }
}