Partner API Structure

In order to integrate with our Partner Portal, the base URL of all API endpoints is

https://partners.clym.io/api/portal

When calling API endpoints that change a resource, you must provide a JSON request body with the Content-Type: application/json HTTP header set.

When calling API endpoints that perform asset uploading, you must use the multipart/form-data encoding with the Content-Type: multipart/form-data HTTP header set and the asset under the asset field.

All API endpoints will return JSON data with the Content-Type: application/json response HTTP header set.

The following status codes can be returned:

Status code
Description

2xx

Everything worked as expected

400

The request data was unacceptable, most likely due to missing required params or invalid specified data.

401

The specified API key is not valid

403

The API key does not have permissions to perform the request.

404

The specified API endpoint, resource or requested resource does not exist.

429

Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.

5xx

Server errors, something went wrong on Clym's end.

Last updated