---
title: "/people/{personIdType}:{personId}/notes"
method: POST
path: "/people/{personIdType}:{personId}/notes"
---

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

`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

This endpoint is the same as [POST /people/{vanId}/notes](ref:people#peoplevanidnotes-1) but uses external IDs rather than VANIDs.

## Path parameters

- `personIdType` string, required
- `personId` string, required

## Request body

- object
  - `text` string: Required; the content of the description of the Person.
  - `isViewRestricted` string: 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`,
    - `noteCategoryId` integer: Unique identifier for a Note Category in this context
  - `contactHistory` object
    - `contactTypeId` string: Optional; a valid [Contact Type ID](https://everyaction.readme.io/reference#canvassresponsescontacttypes)
    - `inputTypeId` string: Optional; a valid [Input Type ID](https://everyaction.readme.io/reference#canvassresponsesinputtypes) (defaults to `11` → API)
    - `dateCanvassed` string, date: Optional; the [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) formatted date that the canvass attempt was made (defaults to today’s date)
    - `resultCodeId` string: Optional; specifies the [Result Code](https://everyaction.readme.io/reference#canvassresponsesresultcodes) of this Contact History. If no `resultCodeId` is specified, a result of *Canvassed* is applied. The `resultCodeId` must be a valid [Result Code](https://everyaction.readme.io/reference#canvassresponsesresultcodes) in the current context.

## Response `204`

204

## Other responses

- `400`: 400
- `404`: 404

## Changes

- **2026-11-03** `4f2049fba5af`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ngpvan/apis/van-crm/changes/people/:personIdType::personId/notes/post.md)

---

[API](https://skmtc.dev/ngpvan/apis/van-crm.md) - [All operations](https://skmtc.dev/ngpvan/apis/van-crm/llms.txt) - [OpenAPI document](https://skmtc.dev/ngpvan/apis/van-crm/revisions/4f2049fba5af?raw)