Domains
The following endpoints allow you to view and manage your partner domains.
An array with all partner domains
GET /api/portal/domains HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
An array with all partner domains
{
"meta": {
"current_page": 1,
"next_page": 1,
"prev_page": 1
},
"result": [
{
"id": "1f19dbcbc7b84be5b40ffcc4ya0zqbtr",
"hostname": "mycompany.com",
"status": "NEW",
"instance_property_id": "7a56a154e6d242d796b9afdfx4clzjrg",
"instance_company_id": "57cb7126dbbe4320b8c30be7uh1tj7h7",
"updated_at": "2025-08-22T17:25:51.855Z",
"created_at": "2025-08-22T17:25:51.855Z",
"activated_at": "2025-08-22T17:25:51.855Z",
"is_active": true,
"email": "[email protected]",
"company_trade_name": "My Company Inc",
"company_id_number": "333000",
"has_scripts": true,
"has_dsar": true,
"has_docs": true,
"has_accessibility": true,
"display_company": true,
"display_dpo": true,
"default_notice_type": "CLASSIC",
"source": "API",
"partner_id": "ac276ff57f9b4d2196c28927gxh25xx6",
"privacy_widget": "<script>\nwindow._clymInit=window._clymInit||[];\nwindow._clymInit.push(['privacy','YOUR_PROPERTY_ID',{}]);\n</script>\n<script src='https://widget.clym-sdk.net/blocking.js'></script>\n<script src='https://widget.clym-sdk.net/clym.js' async></script>\n",
"privacy_center_link": "<a href=\"#\" onclick=\"Clym.showWidget();\">Privacy Center</a>\n",
"privacy_dnt_link": "<a href=\"#\" onclick=\"Clym.showWidget('/requests/new/do_not_sell_my_information');\">Do not sell my personal information</a>\n",
"merchants": [
"text"
],
"instance": {
"id": 1,
"name": "text",
"hostname": "text"
},
"property": {
"id": "7a56a154e6d242d796b9afdfx4clzjrg",
"name": "mycompany.com",
"company": {
"id": "57cb7126dbbe4320b8c30be7uh1tj7h7",
"name": "My Company Inc",
"email": "[email protected]",
"address": {
"country": "US",
"city": "Stuart",
"address": "950 S Kanner Hwy Apt 401",
"postal_code": "34994",
"phone_number": "+1 980 446 8535"
},
"owner": {
"id": "2c2d74241aff420a87f9f6dapr5mkaok",
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe"
}
}
},
"subscription": {
"id": "text",
"status": "NEW",
"start_date": "2025-08-22T17:25:51.855Z",
"end_date": "2025-08-22T17:25:51.855Z",
"created_at": "2025-08-22T17:25:51.855Z",
"price": {
"id": 1,
"frequency": "MONTH",
"currency": {
"id": "text",
"name": "text"
},
"price_amount": 1,
"price_list": {
"id": 1,
"type": "text",
"code": "text"
},
"product": {
"id": 1,
"type": "text",
"name": "text"
}
}
}
}
]
}
Create a new domain in your partner account. Note that some fields are required and some are optional, depending on the onboarding configuration setup for your partner. To find out more, reach out to your partner account manager.
The domain to be registered
mycompany.com
The billing product code for this domain. Available under /products
BASE
The billing price list code for this domain
RESELLER
The company legal name
My Company Inc
The company trade name if different from the company (legal) name
My Company
Internal company ID number
333000
The email account of the domain owner. This email address will be used for all transactional emails (including onboarding emails).
[email protected]
The first name of the individual owning the domain
John
The last name of the individual owning the domain
Doe
The phone number of the individual owning the domain
19804468535
Company VAT number
GB493049
Company registration number
49434993
Company country code in ISO 3166-1 alpha-2
US
Company state code in ISO 3166-1 alpha-2
FL
Company city
Stuart
Company address
950 S Kanner Hwy Apt 401
Company postal code
34994
Domain primary color
#c3c3c3
Optional, when disabled, the widget will not handle any kind of consent/cookie management and will not block any scripts.
true
Optional, when disabled, the widget will not allow any Data Subject Request creation
true
Optional, when disabled, the widget will not display any legal documents
false
Optional, when disabled, the widget will not have any accessibility functionality enabled.
true
Optional, when disabled, the DPO information in the widget will be hidden
true
Optional, when disabled, the Company tab in the widget will be hidden
false
Optional, if specified, additional subdomains to be created to the property
Optional default widget notification type to be used by the widget
Determine if the system will send the customized email or not
false
CREATE_SILENT
Possible values: The merchant id to be assigned to this domain
1111111
Domain added to the partner account
POST /api/portal/domains HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 723
{
"domain": "mycompany.com",
"product": "BASE",
"price_list": "RESELLER",
"company_name": "My Company Inc",
"company_trade_name": "My Company",
"company_id_number": "333000",
"account_email": "[email protected]",
"account_first_name": "John",
"account_last_name": "Doe",
"phone_number": 19804468535,
"vat_number": "GB493049",
"registration_number": "49434993",
"country": "US",
"state": "FL",
"city": "Stuart",
"address": "950 S Kanner Hwy Apt 401",
"postal_code": "34994",
"primary_color": "#c3c3c3",
"has_scripts": true,
"has_dsar": true,
"has_docs": false,
"has_accessibility": true,
"display_dpo": true,
"display_company": false,
"subdomains": [
"https://example.com"
],
"default_notice_type": "CLASSIC",
"send_intro": false,
"action": "CREATE_SILENT",
"merchant_id": "1111111"
}
Domain added to the partner account
{
"id": "1f19dbcbc7b84be5b40ffcc4ya0zqbtr",
"hostname": "mycompany.com",
"status": "NEW",
"instance_property_id": "7a56a154e6d242d796b9afdfx4clzjrg",
"instance_company_id": "57cb7126dbbe4320b8c30be7uh1tj7h7",
"updated_at": "2025-08-22T17:25:51.855Z",
"created_at": "2025-08-22T17:25:51.855Z",
"is_active": true,
"email": "[email protected]",
"company_trade_name": "My Company Inc",
"company_id_number": "333000",
"has_scripts": true,
"has_dsar": true,
"has_docs": false,
"has_accessibility": true,
"display_company": false,
"display_dpo": true,
"default_notice_type": "CLASSIC",
"source": "API",
"partner_id": "ac276ff57f9b4d2196c28927gxh25xx6",
"privacy_widget": "<script>\nwindow._clymInit=window._clymInit||[];\nwindow._clymInit.push(['privacy','YOUR_PROPERTY_ID',{}]);\n</script>\n<script src='https://widget.clym-sdk.net/blocking.js'></script>\n<script src='https://widget.clym-sdk.net/clym.js' async></script>\n",
"privacy_center_link": "<a href=\"#\" onclick=\"Clym.showWidget();\">Privacy Center</a>\n",
"privacy_dnt_link": "<a href=\"#\" onclick=\"Clym.showWidget('/requests/new/do_not_sell_my_information');\">Do not sell my personal information</a>\n"
}
Retrieve information about a single domain
Domain id
The partner domain information
GET /api/portal/domains/{domainId} HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
The partner domain information
{
"id": "1f19dbcbc7b84be5b40ffcc4ya0zqbtr",
"hostname": "mycompany.com",
"status": "NEW",
"instance_property_id": "7a56a154e6d242d796b9afdfx4clzjrg",
"instance_company_id": "57cb7126dbbe4320b8c30be7uh1tj7h7",
"updated_at": "2025-08-22T17:25:51.855Z",
"created_at": "2025-08-22T17:25:51.855Z",
"activated_at": "2025-08-22T17:25:51.855Z",
"is_active": true,
"email": "[email protected]",
"company_trade_name": "My Company Inc",
"company_id_number": "333000",
"has_scripts": true,
"has_dsar": true,
"has_docs": true,
"has_accessibility": true,
"display_company": true,
"display_dpo": true,
"default_notice_type": "CLASSIC",
"source": "API",
"partner_id": "ac276ff57f9b4d2196c28927gxh25xx6",
"privacy_widget": "<script>\nwindow._clymInit=window._clymInit||[];\nwindow._clymInit.push(['privacy','YOUR_PROPERTY_ID',{}]);\n</script>\n<script src='https://widget.clym-sdk.net/blocking.js'></script>\n<script src='https://widget.clym-sdk.net/clym.js' async></script>\n",
"privacy_center_link": "<a href=\"#\" onclick=\"Clym.showWidget();\">Privacy Center</a>\n",
"privacy_dnt_link": "<a href=\"#\" onclick=\"Clym.showWidget('/requests/new/do_not_sell_my_information');\">Do not sell my personal information</a>\n",
"merchants": [
"text"
],
"instance": {
"id": 1,
"name": "text",
"hostname": "text"
},
"property": {
"id": "7a56a154e6d242d796b9afdfx4clzjrg",
"name": "mycompany.com",
"company": {
"id": "57cb7126dbbe4320b8c30be7uh1tj7h7",
"name": "My Company Inc",
"email": "[email protected]",
"address": {
"country": "US",
"city": "Stuart",
"address": "950 S Kanner Hwy Apt 401",
"postal_code": "34994",
"phone_number": "+1 980 446 8535"
},
"owner": {
"id": "2c2d74241aff420a87f9f6dapr5mkaok",
"email": "[email protected]",
"first_name": "John",
"last_name": "Doe"
}
}
},
"subscription": {
"id": "text",
"status": "NEW",
"start_date": "2025-08-22T17:25:51.855Z",
"end_date": "2025-08-22T17:25:51.855Z",
"created_at": "2025-08-22T17:25:51.855Z",
"price": {
"id": 1,
"frequency": "MONTH",
"currency": {
"id": "text",
"name": "text"
},
"price_amount": 1,
"price_list": {
"id": 1,
"type": "text",
"code": "text"
},
"product": {
"id": 1,
"type": "text",
"name": "text"
}
}
}
}
Update information about a domain
Domain id
The company legal name
My Company Inc
The company trade name if different from the company (legal) name
My Company
Internal company ID number
333000
Company country code in ISO 3166-1 alpha-2
US
Company state code in ISO 3166-1 alpha-2
FL
Company city
Stuart
Company address
950 S Kanner Hwy Apt 401
Company postal code
34994
Domain primary color
#c3c3c3
Optional, when disabled, the widget will not handle any kind of consent/cookie management and will not block any scripts.
true
Optional, when disabled, the widget will not allow any Data Subject Request creation
true
Optional, when disabled, the widget will not display any legal documents
false
Optional, when disabled, the widget will not have any accessibility functionality enabled.
true
Optional, when disabled, the DPO information in the widget will be hidden
true
Optional, when disabled, the Company tab in the widget will be hidden
false
Optional default widget notification type to be used by the widget
Acknowledgement that request was successful.
PUT /api/portal/domains/{domainId} HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 377
{
"company_name": "My Company Inc",
"company_trade_name": "My Company",
"company_id_number": "333000",
"country": "US",
"state": "FL",
"city": "Stuart",
"address": "950 S Kanner Hwy Apt 401",
"postal_code": "34994",
"primary_color": "#c3c3c3",
"has_scripts": true,
"has_dsar": true,
"has_docs": false,
"has_accessibility": true,
"display_dpo": true,
"display_company": false,
"default_notice_type": "CLASSIC"
}
Acknowledgement that request was successful.
{
"result": {
"id": "text"
}
}
Completely delete the domain and all associated functionality from your partner account
Domain id
Domain deletion confirmation
DELETE /api/portal/domains/{domainId} HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Domain deletion confirmation
{
"result": {
"deleted": true
}
}
Deactivate an active domain, changing its status to INACTIVE. The domain will be excluded from the list of partner domains.
Domain id
Acknowledgement that request was successful.
POST /api/portal/domains/{domainId}/deactivate HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Acknowledgement that request was successful.
{
"result": {}
}
Activate a deactivated domain. The domain will be included in the list of partner domains.
Domain id
Acknowledgement that request was successful.
POST /api/portal/domains/{domainId}/activate HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Acknowledgement that request was successful.
{
"result": {}
}
Send an invitation email to start the onboarding process for the specified domain. The email will be sent to the email address of the account owner and the domain status will change to INVITED. Once we start receiving the first page views, the domain status will change to ACTIVE
Domain id
Determine if the system will send the customized intro email or not.
Acknowledgement that request was successful.
POST /api/portal/domains/{domainId}/invite HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 20
{
"send_invite": true
}
Acknowledgement that request was successful.
{
"result": {}
}
Retrieves all the previously created subdomains of the specified domain
Domain id
A list of the domain's subdomains
GET /api/portal/domains/{domainId}/subdomains HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
A list of the domain's subdomains
{
"result": [
{
"id": "a9a678b195ff46bb865c3b1ec6wbbta8",
"hostname": "shop.andona.com",
"instance_domain_id": "b23cf02ffbe14a79bf543a845umpk5vj",
"updated_at": "2023-02-18T14:57:58.000Z",
"created_at": "2023-02-18T14:57:58.000Z",
"domain_id": "2634b4d4183947cf95c99d99axwau9h8",
"instance_id": "1"
}
]
}
Adds a new subdomain to the specified domain
Domain id
The full hostname of the subdomain to be added
Acknowledgement that request was successful.
POST /api/portal/domains/{domainId}/subdomains HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35
{
"subdomain": "https://example.com"
}
Acknowledgement that request was successful.
{
"id": "a9a678b195ff46bb865c3b1ec6wbbta8",
"hostname": "shop.andona.com",
"instance_domain_id": "b23cf02ffbe14a79bf543a845umpk5vj",
"updated_at": "2023-02-18T14:57:58.000Z",
"created_at": "2023-02-18T14:57:58.000Z",
"domain_id": "2634b4d4183947cf95c99d99axwau9h8",
"instance_id": "1"
}
Removes the specified subdomain from the specified domain
Domain id
The previously-created subdomain hostname
Acknowledgement that request was successful.
DELETE /api/portal/domains/{domainId}/subdomains/{subdomain} HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Acknowledgement that request was successful.
{
"result": {
"deleted": true
}
}
Changes the product and price list of the domain's subscription.
Domain id
The target product code, available in the /products section
The target price list code, available in the /products section
Subscription product change acknowledgement
POST /api/portal/domains/{domainId}/subscription/product HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38
{
"product": "text",
"price_list": "text"
}
Subscription product change acknowledgement
{
"result": {
"changed": true
}
}
Changes the product and price list in bulk, for up to 100 domains at once
Subscription product change acknowledgement
POST /api/portal/domains/bulk/subscription/product HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 62
{
"domains": {
"id": "text",
"product": "text",
"price_list": "text"
}
}
Subscription product change acknowledgement
{
"result": {
"changed": [
{
"domain_id": "text",
"changed": true
}
],
"failed": [
{
"domain_id": "text",
"error": {
"code": "DATA.INVALID_NAME",
"ns": "DATA",
"message": "text",
"status": 400,
"data": {}
}
}
]
}
}
Last updated