The Lost Reason Detail object

Attributes

id string

Unique identifier for the object.

idx integer
parent_id string
parent_type string
lost_reason string
The Lost Reason Detail object 
{
  "id": "lost-reason-detail_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "lost_reason": "lost_reason_example"
}
GET /api/crm/lost-reason-detail?parent_id={id}

List lost reason details by parent

Returns all lost reason details belonging to the specified parent.

Query parameters

parent_id string required

The ID of the parent to list children for.

Returns

A list of lost reason detail objects belonging to the parent.

GET /api/crm/lost-reason-detail?parent_id={id} 
curl https://api.overplane.dev/api/crm/lost-reason-detail?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "lost-reason-detail_abc123",
      "idx": 1,
      "parent_id": null,
      "parent_type": "parent_type_example",
      "lost_reason": "lost_reason_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/crm/lost-reason-detail

Create a lost reason detail

Creates a new lost reason detail object.

Body parameters

idx integer
parent_id string
parent_type string
lost_reason string

Returns

Returns the newly created lost reason detail object if the call succeeded.

POST /api/crm/lost-reason-detail 
curl https://api.overplane.dev/api/crm/lost-reason-detail \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "lost-reason-detail_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "lost_reason": "lost_reason_example"
}
PATCH /api/crm/lost-reason-detail/{id}

Update a lost reason detail

Updates the specified lost reason detail 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 lost reason detail to update.

Body parameters

idx integer
parent_id string
parent_type string
lost_reason string

Returns

Returns the updated lost reason detail object.

PATCH /api/crm/lost-reason-detail/{id} 
curl https://api.overplane.dev/api/crm/lost-reason-detail/lost-reason-detail_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"idx":1,"parent_id":null}'
Response 
{
  "id": "lost-reason-detail_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "lost_reason": "lost_reason_example"
}
DELETE /api/crm/lost-reason-detail/{id}

Delete a lost reason detail

Permanently deletes a lost reason detail. This cannot be undone.

Path parameters

id string required

The identifier of the lost reason detail to delete.

Returns

Returns a confirmation that the lost reason detail has been deleted.

DELETE /api/crm/lost-reason-detail/{id} 
curl https://api.overplane.dev/api/crm/lost-reason-detail/lost-reason-detail_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "lost-reason-detail_abc123",
  "deleted": true
}
POST /api/crm/lost-reason-detail/reorder

Reorder lost reason details

Updates the sort order of lost reason details within their parent by setting new index values.

Returns

Returns the reordered list.

POST /api/crm/lost-reason-detail/reorder 
curl https://api.overplane.dev/api/crm/lost-reason-detail/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "lost-reason-detail_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "lost_reason": "lost_reason_example"
}