The Sales Partner Type 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.

sales_partner_type string required
The Sales Partner Type object 
{
  "id": "sales-partner-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "sales_partner_type": "sales_partner_type_example"
}
GET /api/crm/sales-partner-type/{id}

Retrieve a sales partner type

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

Path parameters

id string required

The identifier of the sales partner type to retrieve.

Returns

Returns the sales partner type object if a valid identifier was provided.

GET /api/crm/sales-partner-type/{id} 
curl https://api.overplane.dev/api/crm/sales-partner-type/sales-partner-type_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "sales-partner-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "sales_partner_type": "sales_partner_type_example"
}
GET /api/crm/sales-partner-type

List all sales partner types

Returns a list of sales partner types. 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 partner type objects.

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

Create a sales partner type

Creates a new sales partner type object.

Body parameters

sales_partner_type string required

Returns

Returns the newly created sales partner type object if the call succeeded.

POST /api/crm/sales-partner-type 
curl https://api.overplane.dev/api/crm/sales-partner-type \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"sales_partner_type":"sales_partner_type_example"}'
Response 
{
  "id": "sales-partner-type_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "sales_partner_type": "sales_partner_type_example"
}
PATCH /api/crm/sales-partner-type/{id}

Update a sales partner type

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

Body parameters

sales_partner_type string

Returns

Returns the updated sales partner type object.

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

Delete a sales partner type

Permanently deletes a sales partner type. This cannot be undone.

Path parameters

id string required

The identifier of the sales partner type to delete.

Returns

Returns a confirmation that the sales partner type has been deleted.

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