Notes

Notes on customers, companies, leads and deals.

GET List notes on a record
POST Add a note to a record
GET Get a note
PATCH Edit a note
DELETE Delete a note

#List notes on a record

GET/api/v1/notes

Operation list_notes · needs scope notes:read

The most recent notes on one record, pinned first. Not pageable: pagination.hasMore says whether older notes exist beyond limit.

Parameter	In	Type	Notes
`record_type` required	query	person \| company \| lead \| opportunity
`record_id` required	query	string
`limit`	query	integer	Page size, at most 100.

bash

curl https://synconone.com/api/v1/notes?record_type=person&record_id=pr_1a2b3c4d5e6f7a8b \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

json

{
  "data": [
    {
      "id": "pr_1a2b3c4d5e6f7a8b",
      "object": "string",
      "body": "Asked about annual terms on the website.",
      "author": "string",
      "author_kind": "string",
      "pinned": true,
      "person": "string",
      "company": "string",
      "lead": "string",
      "opportunity": "string"
    }
  ],
  "pagination": {
    "nextCursor": null,
    "hasMore": false
  }
}

Errors: 401: Missing, invalid, revoked or expired API key. · 403: The key lacks the scope, or its role cannot do this. · 422: Validation failed. · 429: Rate limited. Honour Retry-After.. See errors.

#Add a note to a record

POST/api/v1/notes

Operation create_note · needs scope notes:write

Body field	Type	Notes
`record_type` required	person \| company \| lead \| opportunity
`record_id` required	string
`body` required	string
`pinned`	boolean

bash

curl -X POST https://synconone.com/api/v1/notes \
  -H "Authorization: Bearer sk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"record_type":"person","record_id":"pr_1a2b3c4d5e6f7a8b","body":"Asked about annual terms on the website.","pinned":true}'

json

{
  "data": {
    "id": "pr_1a2b3c4d5e6f7a8b",
    "object": "string",
    "body": "Asked about annual terms on the website.",
    "author": "string",
    "author_kind": "string",
    "pinned": true,
    "person": "string",
    "company": "string",
    "lead": "string",
    "opportunity": "string"
  }
}

Errors: 401: Missing, invalid, revoked or expired API key. · 403: The key lacks the scope, or its role cannot do this. · 409: Conflict, approval required, or idempotent request in progress. · 422: Validation failed. · 429: Rate limited. Honour Retry-After.. See errors.

#Get a note

GET/api/v1/notes/{id}

Operation get_note · needs scope notes:read

Parameter	In	Type	Notes
`id` required	path	string	Public id of the note.

bash

curl https://synconone.com/api/v1/notes/pr_1a2b3c4d5e6f7a8b \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

json

{
  "data": {
    "id": "pr_1a2b3c4d5e6f7a8b",
    "object": "string",
    "body": "Asked about annual terms on the website.",
    "author": "string",
    "author_kind": "string",
    "pinned": true,
    "person": "string",
    "company": "string",
    "lead": "string",
    "opportunity": "string"
  }
}

Errors: 401: Missing, invalid, revoked or expired API key. · 403: The key lacks the scope, or its role cannot do this. · 404: Not found, or not visible to this key. · 422: Validation failed. · 429: Rate limited. Honour Retry-After.. See errors.

#Edit a note

PATCH/api/v1/notes/{id}

Operation update_note · needs scope notes:write

Change the text, pin or unpin it, or both.

Parameter	In	Type	Notes
`id` required	path	string	Public id of the note.

Body field	Type	Notes
`body`	string
`pinned`	boolean

bash

curl -X PATCH https://synconone.com/api/v1/notes/pr_1a2b3c4d5e6f7a8b \
  -H "Authorization: Bearer sk_live_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"body":"Asked about annual terms on the website.","pinned":true}'

json

{
  "data": {
    "id": "pr_1a2b3c4d5e6f7a8b",
    "object": "string",
    "body": "Asked about annual terms on the website.",
    "author": "string",
    "author_kind": "string",
    "pinned": true,
    "person": "string",
    "company": "string",
    "lead": "string",
    "opportunity": "string"
  }
}

Errors: 401: Missing, invalid, revoked or expired API key. · 403: The key lacks the scope, or its role cannot do this. · 404: Not found, or not visible to this key. · 409: Conflict, approval required, or idempotent request in progress. · 422: Validation failed. · 429: Rate limited. Honour Retry-After.. See errors.

#Delete a note

DELETE/api/v1/notes/{id}

Operation delete_note · needs scope notes:write

Removes it from the record. An administrator can still recover it.

Parameter	In	Type	Notes
`id` required	path	string	Public id of the note.

bash

curl -X DELETE https://synconone.com/api/v1/notes/pr_1a2b3c4d5e6f7a8b \
  -H "Authorization: Bearer sk_live_YOUR_KEY"

json

{
  "data": {
    "id": "pr_1a2b3c4d5e6f7a8b",
    "object": "string",
    "deleted": true
  }
}