/people/{personIdType}:{personId}/notes

Changed on

This endpoint is the same as POST /people/{vanId}/notes but uses external IDs rather than VANIDs.

post/people/{personIdType}:{personId}/notes

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/people/{personIdType}:{personId}/notes
  • Auth
    HTTP basic

Path parameters

personIdTypestring required

Required; a known person identifier type available in the current context

personIdstring required

Required; an external identifier, URL encoded

Request body

textstring

Required; the content of the description of the Person.

isViewRestrictedstring

Required; set to true if the note should be restricted only to certain users within the current context; set to false if the note may be viewed by any user in the current context.

Response

204

Changes