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

partner_name string required
partner_type string
territory string required
commission_rate number required
show_in_website boolean

Default: false

referral_code string
route string
logo string
partner_website string
introduction string
description string
The Sales Partner object 
{
  "id": "sales-partner_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "partner_name": "partner_name_example",
  "partner_type": "partner_type_example",
  "territory": "territory_example",
  "commission_rate": 0,
  "show_in_website": false,
  "referral_code": "referral_code_example",
  "route": "route_example",
  "logo": "logo_example",
  "partner_website": "partner_website_example",
  "introduction": "introduction_example",
  "description": "description_example"
}
GET /api/setup/sales-partner/{id}

Retrieve a sales partner

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

Path parameters

id string required

The identifier of the sales partner to retrieve.

Returns

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

GET /api/setup/sales-partner/{id} 
curl https://api.overplane.dev/api/setup/sales-partner/sales-partner_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "id": "sales-partner_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "partner_name": "partner_name_example",
  "partner_type": "partner_type_example",
  "territory": "territory_example",
  "commission_rate": 0,
  "show_in_website": false,
  "referral_code": "referral_code_example",
  "route": "route_example",
  "logo": "logo_example",
  "partner_website": "partner_website_example",
  "introduction": "introduction_example",
  "description": "description_example"
}
GET /api/setup/sales-partner

List all sales partners

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

GET /api/setup/sales-partner 
curl https://api.overplane.dev/api/setup/sales-partner \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "sales-partner_abc123",
      "created_at": "2024-01-15T09: 30: 00Z",
      "updated_at": "2024-01-15T09: 30: 00Z",
      "partner_name": "partner_name_example",
      "partner_type": "partner_type_example",
      "territory": "territory_example",
      "commission_rate": 0,
      "show_in_website": false,
      "referral_code": "referral_code_example",
      "route": "route_example",
      "logo": "logo_example",
      "partner_website": "partner_website_example",
      "introduction": "introduction_example",
      "description": "description_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/setup/sales-partner

Create a sales partner

Creates a new sales partner object.

Body parameters

partner_name string required
partner_type string
territory string required
commission_rate number required
show_in_website boolean

Default: false

referral_code string
route string
logo string
partner_website string
introduction string
description string

Returns

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

POST /api/setup/sales-partner 
curl https://api.overplane.dev/api/setup/sales-partner \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"partner_name":"partner_name_example","territory":"territory_example","commission_rate":0}'
Response 
{
  "id": "sales-partner_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "partner_name": "partner_name_example",
  "partner_type": "partner_type_example",
  "territory": "territory_example",
  "commission_rate": 0,
  "show_in_website": false,
  "referral_code": "referral_code_example",
  "route": "route_example",
  "logo": "logo_example",
  "partner_website": "partner_website_example",
  "introduction": "introduction_example",
  "description": "description_example"
}
PATCH /api/setup/sales-partner/{id}

Update a sales partner

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

Body parameters

partner_name string
partner_type string
territory string
commission_rate number
show_in_website boolean

Default: false

referral_code string
route string
logo string
partner_website string
introduction string
description string

Returns

Returns the updated sales partner object.

PATCH /api/setup/sales-partner/{id} 
curl https://api.overplane.dev/api/setup/sales-partner/sales-partner_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"partner_name":"partner_name_example","partner_type":"partner_type_example"}'
Response 
{
  "id": "sales-partner_abc123",
  "created_at": "2024-01-15T09: 30: 00Z",
  "updated_at": "2024-01-15T09: 30: 00Z",
  "partner_name": "partner_name_example",
  "partner_type": "partner_type_example",
  "territory": "territory_example",
  "commission_rate": 0,
  "show_in_website": false,
  "referral_code": "referral_code_example",
  "route": "route_example",
  "logo": "logo_example",
  "partner_website": "partner_website_example",
  "introduction": "introduction_example",
  "description": "description_example"
}
DELETE /api/setup/sales-partner/{id}

Delete a sales partner

Permanently deletes a sales partner. This cannot be undone.

Path parameters

id string required

The identifier of the sales partner to delete.

Returns

Returns a confirmation that the sales partner has been deleted.

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