Sign in

v7

latestOpenAPI 3.1.02026-08-0431138164.3 KB
Prospect

Create Internal Note Endpoint

Create an internal note on a prospect or resident conversation.

post/v1/prospect/internal-note

Request body

elise_prospect_idstring

Elise prospect ID. Provide exactly one of elise_prospect_id or elise_resident_id.

elise_resident_idinteger

Elise resident ID. Provide exactly one of elise_prospect_id or elise_resident_id.

notestring required

Note body. Must be non-empty; max 2000 characters.

user_idstring

Author user ID. If provided, the note is attributed to that user; if omitted, the note is marked as an external (vendor) note with no human author.

vendor_namestring

Optional source label shown as the note's author in the conversation thread when no author user_id is provided (e.g. the vendor or system that created it).

Example request

{
  "elise_prospect_id": "c21b94e2-0280-415d-9d1e-091b547a0061",
  "elise_resident_id": 12345,
  "note": "Spoke with applicant — confirmed move-in date.",
  "user_id": "b53afbd2-973b-11ef-ba7c-1a68fe4c92b7",
  "vendor_name": "Zillow"
}

Response

Successful Response

note_idinteger required