The CRM Note object

Attributes

id string

Unique identifier for the object.

idx integer
parent_id string required
parent_type string required
note string
added_by string
added_on string
The CRM Note object 
{
  "id": "c-r-m-note_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "note": "note_example",
  "added_by": "added_by_example",
  "added_on": "added_on_example"
}
GET /api/crm/c-r-m-note?parent_id={id}

List crm notes by parent

Returns all crm notes belonging to the specified parent.

Query parameters

parent_id string required

The ID of the parent to list children for.

Returns

A list of crm note objects belonging to the parent.

GET /api/crm/c-r-m-note?parent_id={id} 
curl https://api.overplane.dev/api/crm/c-r-m-note?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "c-r-m-note_abc123",
      "idx": 1,
      "parent_id": null,
      "parent_type": "parent_type_example",
      "note": "note_example",
      "added_by": "added_by_example",
      "added_on": "added_on_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/crm/c-r-m-note

Create a crm note

Creates a new crm note object.

Body parameters

idx integer
parent_id string required
parent_type string required
note string
added_by string
added_on string

Returns

Returns the newly created crm note object if the call succeeded.

POST /api/crm/c-r-m-note 
curl https://api.overplane.dev/api/crm/c-r-m-note \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"parent_id":null,"parent_type":"parent_type_example"}'
Response 
{
  "id": "c-r-m-note_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "note": "note_example",
  "added_by": "added_by_example",
  "added_on": "added_on_example"
}
PATCH /api/crm/c-r-m-note/{id}

Update a crm note

Updates the specified crm note by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the crm note to update.

Body parameters

idx integer
parent_id string
parent_type string
note string
added_by string
added_on string

Returns

Returns the updated crm note object.

PATCH /api/crm/c-r-m-note/{id} 
curl https://api.overplane.dev/api/crm/c-r-m-note/c-r-m-note_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"idx":1,"parent_id":null}'
Response 
{
  "id": "c-r-m-note_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "note": "note_example",
  "added_by": "added_by_example",
  "added_on": "added_on_example"
}
DELETE /api/crm/c-r-m-note/{id}

Delete a crm note

Permanently deletes a crm note. This cannot be undone.

Path parameters

id string required

The identifier of the crm note to delete.

Returns

Returns a confirmation that the crm note has been deleted.

DELETE /api/crm/c-r-m-note/{id} 
curl https://api.overplane.dev/api/crm/c-r-m-note/c-r-m-note_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "c-r-m-note_abc123",
  "deleted": true
}
POST /api/crm/c-r-m-note/reorder

Reorder crm notes

Updates the sort order of crm notes within their parent by setting new index values.

Returns

Returns the reordered list.

POST /api/crm/c-r-m-note/reorder 
curl https://api.overplane.dev/api/crm/c-r-m-note/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "c-r-m-note_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "note": "note_example",
  "added_by": "added_by_example",
  "added_on": "added_on_example"
}