The Sales Stage 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.

stage_name string
The Sales Stage object 
{
  "id": "sales-stage_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "stage_name": "stage_name_example"
}
GET /api/crm/sales-stage/{id}

Retrieve a sales stage

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

Path parameters

id string required

The identifier of the sales stage to retrieve.

Returns

Returns the sales stage object if a valid identifier was provided.

GET /api/crm/sales-stage/{id} 
curl https://api.overplane.dev/api/crm/sales-stage/sales-stage_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "sales-stage_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "stage_name": "stage_name_example"
}
GET /api/crm/sales-stage

List all sales stages

Returns a list of sales stages. 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 sales stage objects.

GET /api/crm/sales-stage 
curl https://api.overplane.dev/api/crm/sales-stage \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "sales-stage_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "stage_name": "stage_name_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/crm/sales-stage

Create a sales stage

Creates a new sales stage object.

Body parameters

stage_name string

Returns

Returns the newly created sales stage object if the call succeeded.

POST /api/crm/sales-stage 
curl https://api.overplane.dev/api/crm/sales-stage \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json"
Response 
{
  "id": "sales-stage_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "stage_name": "stage_name_example"
}
PATCH /api/crm/sales-stage/{id}

Update a sales stage

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

Body parameters

stage_name string

Returns

Returns the updated sales stage object.

PATCH /api/crm/sales-stage/{id} 
curl https://api.overplane.dev/api/crm/sales-stage/sales-stage_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"stage_name":"stage_name_example"}'
Response 
{
  "id": "sales-stage_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "stage_name": "stage_name_example"
}
DELETE /api/crm/sales-stage/{id}

Delete a sales stage

Permanently deletes a sales stage. This cannot be undone.

Path parameters

id string required

The identifier of the sales stage to delete.

Returns

Returns a confirmation that the sales stage has been deleted.

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