Update a note

URL

POST https://api.complycube.com/v1/notes/:id

Updates the specified note by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Headers

Name	Type	Description
Content-Type*	string	The content-type must always be set to application/json.
Authorization*	string	The API live or test key.

Path parameters

Name	Type	Description
id*	string	The ID of the note.

Body

Name	Type	Description
type	string	The type of note. Valid values are: report internal
note	string	The content of the note.

Example request

cURL

curl -X POST https://api.complycube.com/v1/notes/{:noteId} \
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json' \
     -d '{
          	"type": "report",
          	"note": "Update note"
        }'

Example response

Success (200)

{
    "id": "5eb1276f96be4a0008713af6",
    "clientId": "5eb1276d96be4a0008713af5",
    "type": "report",
    "note": "Update note",
    "createdAt": "2020-01-04T17:24:29.146Z",
    "updatedAt": "2020-01-04T17:13:10.712Z"
}

Resource Not Found (404)