API structure

The Partner API lets you manage your Clym customers programmatically: the domains on your partner account and their subscriptions, your merchants, and the products available to you. Through the instance endpoints you can also work with a merchant's company, property and users (see Instance endpoints).

The base URL for all API endpoints is https://partners.clym.io/api. Every Partner API endpoint lives under /portal — for example https://partners.clym.io/api/portal/domains. All requests are authenticated with a Partner API key (see Authorization).

Requests

For GET and DELETE requests, pass parameters in the query string. When calling an endpoint that creates or changes a resource (POST, PUT), send a JSON request body with the Content-Type: application/json header.

Fields the endpoint does not recognise are ignored rather than rejected, so a misspelled optional field has no effect and produces no error. Check field names against the endpoint reference.

Responses

All responses are JSON. Successful responses wrap the data in a result field:

{
  "result": {
    "id": "1f19dbcbc7b84be5b40ffcc4ya0zqbtr",
    "hostname": "mycompany.com"
  }
}

Paginated list endpoints return { meta, result }, where meta carries the paging information (see Pagination). Errors use standard HTTP status codes and a consistent error envelope — see Errors.