The Competitor object

Attributes

id string

Unique identifier for the object.

created_at string

ISO 8601 timestamp of when the object was created.

updated_at string

ISO 8601 timestamp of when the object was last updated.

competitor_name string required
website string
The Competitor object 
{
  "id": "competitor_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "competitor_name": "competitor_name_example",
  "website": "website_example"
}
GET /api/crm/competitor/{id}

Retrieve a competitor

Retrieves the details of an existing competitor. Supply the unique competitor ID that was returned from a previous request.

Path parameters

id string required

The identifier of the competitor to retrieve.

Returns

Returns the competitor object if a valid identifier was provided.

GET /api/crm/competitor/{id} 
curl https://api.overplane.dev/api/crm/competitor/competitor_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "competitor_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "competitor_name": "competitor_name_example",
  "website": "website_example"
}
GET /api/crm/competitor

List all competitors

Returns a list of competitors. The results are sorted by creation date, with the most recently created appearing first.

Query parameters

limit integer

Maximum number of objects to return. Default: 20.

offset integer

Number of objects to skip for pagination. Default: 0.

Returns

A paginated list of competitor objects.

GET /api/crm/competitor 
curl https://api.overplane.dev/api/crm/competitor \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "competitor_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "competitor_name": "competitor_name_example",
      "website": "website_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/crm/competitor

Create a competitor

Creates a new competitor object.

Body parameters

competitor_name string required
website string

Returns

Returns the newly created competitor object if the call succeeded.

POST /api/crm/competitor 
curl https://api.overplane.dev/api/crm/competitor \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"competitor_name":"competitor_name_example"}'
Response 
{
  "id": "competitor_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "competitor_name": "competitor_name_example",
  "website": "website_example"
}
PATCH /api/crm/competitor/{id}

Update a competitor

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

Body parameters

competitor_name string
website string

Returns

Returns the updated competitor object.

PATCH /api/crm/competitor/{id} 
curl https://api.overplane.dev/api/crm/competitor/competitor_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"competitor_name":"competitor_name_example","website":"website_example"}'
Response 
{
  "id": "competitor_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "competitor_name": "competitor_name_example",
  "website": "website_example"
}
DELETE /api/crm/competitor/{id}

Delete a competitor

Permanently deletes a competitor. This cannot be undone.

Path parameters

id string required

The identifier of the competitor to delete.

Returns

Returns a confirmation that the competitor has been deleted.

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