Notes on leads
Write notes on a lead that your whole team can see.
Read and write the team notes on a lead from your own code. Each note has a commentId, its text, who wrote it and when. The leadId comes from GET /v3/leads. Authenticated with ?privateKey=YOUR_KEY (see Authentication).
| GET | /v3/leads/{leadId}/comments | Get lead comments |
| POST | /v3/leads/{leadId}/comments | Add a comment to a lead |
| PUT | /v3/comments/{commentId} | Edit a lead comment |
| DELETE | /v3/comments/{commentId} | Delete a lead comment |
GET
Parameters
Lead IdLead id (the _id of a row returned by get_leads).
curl -X GET "https://rest-dash.revealid.xyz/v3/leads/6530c1d2e3f4a5b6c7d8e9f2/comments?privateKey=YOUR_KEY"Response
Press Send request to try it with sample data.
What each field accepts
| Field | Type | Limits and format | Accepted values |
|---|---|---|---|
| leadId* | string | — | any |
Use case: Log a call from your phone system
POST /v3/leads/{leadId}/comments with { "content": "Called, interested, follow up Friday" }. Every call adds a new note, signed with the user the API key belongs to.
Use case: Correct or remove a note
PUT /v3/comments/{commentId} with the new content replaces the text; DELETE /v3/comments/{commentId} removes it. Both work only for the user who wrote the note; anyone else gets You do not have permission.