Create a note

URL

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

Creates a new note.

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.

Body

Name	Type	Description
clientId*	string	The ID of the client associated with this note.
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 \
     -H 'Authorization: <YOUR_API_KEY>' \
     -H 'Content-Type: application/json' \
     -d '{
               "clientId":"CLIENT_ID",
               "type": "internal",
               "note": "Sample note"
        }'

Example responses

Success (200)

{
    "id": "5eb1276f96be4a0008713af6",
    "clientId": "69e7531f8a80b2000237786a",
    "type": "internal",
    "note": "Sample note",
    "createdAt": "2020-01-04T17:24:29.146Z",
    "updatedAt": "2020-01-04T17:24:29.146Z"
}

Invalid Request (400)

{
    "type": "invalid_request",
    "message": "'type' should be equal to one of the allowed values:report,internal",
    "param": "type"
}

Resource Not Found (404)

{
    "type": "resource_not_found",
    "message": "Invalid client id '69e7531f8a80b2000237786b'"
}