Add a shortlist note

POST https://api.vamotalent.ai/v2/shortlists/{id}/notes
Access
Authenticated
shortlist:update
Cost
Free
Rate limit
120 / minute per account
Quota
None

Add a note about a shortlist as a whole: what it is for, what to do next. The note is saved with its author and the time. It cannot be edited or deleted afterwards, so a correction is another note. To write about one person, add a contact note with POST /v2/contacts/{contactId}/notes: it is shown wherever that person appears and can be edited.

Path parameters

  • id string required
    max 16 chars

Request body AddShortlistNoteRequest application/json

  • body string required

    The note, in plain words. 1 to 4000 characters.

    max 4000 chars

Responses

The note as saved

  • id string required

    The note id.

  • shortlistId string required

    The shortlist the note is on.

  • body string required

    The note text, as written.

  • author NoteAuthor required

    Who wrote a note, or who last edited it.

    • kind string required

      What wrote the note: `member` is a person on the account, `key` is an API key, `tool` is an AI tool a person signed in, and `system` is Vamo.

      memberkeytoolsystem
    • id string | null required

      The id of that member, key or tool connection. Null for `system`.

    • name string | null required

      What to call them: the person’s name for a member, the key’s label for a key, the tool’s name for a tool, and `Vamo` for `system`. Null when no name is held.

  • createdAt string required

    When the note was written, as an ISO 8601 instant.