Skip to content
Clym

API structure

The Partner API manages the domains on your partner account and their subscriptions, your merchants, and the products available to you. The instance endpoints also reach a merchant's own company, property and users (see Instance endpoints).

Every endpoint lives under /portal on https://partners.clym.io/api — for example https://partners.clym.io/api/portal/domains — and is authenticated with a Partner API key (see Authorization).

Requests

GET and DELETE take query-string parameters. POST and PUT take a JSON body with the Content-Type: application/json header.

Unrecognised fields are ignored rather than rejected, so a misspelled optional field silently has no effect. Check names against the endpoint reference.

Responses

All responses are JSON. Single-resource endpoints wrap the data in { result }:

{
  "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 envelope (see Errors).

© 2026 Clym Partner PortalTermsPrivacy policyCookie policy