The Competitor Detail object

Attributes

id string

Unique identifier for the object.

idx integer
parent_id string required
parent_type string required
competitor string required
The Competitor Detail object 
{
  "id": "competitor-detail_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "competitor": "competitor_example"
}
GET /api/crm/competitor-detail?parent_id={id}

List competitor details by parent

Returns all competitor 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 competitor detail objects belonging to the parent.

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

Create a competitor detail

Creates a new competitor detail object.

Body parameters

idx integer
parent_id string required
parent_type string required
competitor string required

Returns

Returns the newly created competitor detail object if the call succeeded.

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

Update a competitor detail

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

Body parameters

idx integer
parent_id string
parent_type string
competitor string

Returns

Returns the updated competitor detail object.

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

Delete a competitor detail

Permanently deletes a competitor detail. This cannot be undone.

Path parameters

id string required

The identifier of the competitor detail to delete.

Returns

Returns a confirmation that the competitor detail has been deleted.

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

Reorder competitor details

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

Returns

Returns the reordered list.

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