API Reference

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

post
https://api.securevan.com/v4/people/:/notes

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Defaults to GWID

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

string
required
Defaults to 3

Required; an external identifier, URL encoded

Body Params
string
Defaults to Great chat! This person will be able to volunteer next year.

Required; the content of the description of the Person.

string
Defaults to false

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.

category
object

Optional; if specified, must be an object whose noteCategoryId corresponds to a Note Category which may be applied to People, and which is available at GET /notes/categories,

contactHistory
object
Responses

Updated 12 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 months ago