Property
The following endpoints allow you to view and manage the specified merchant/domain's property configuration and widget settings.
Retrieve the property information and configuration
API key generated in Clym Partner Portal.
Either a merchant ID or a domain ID is required
Result with an array of records
GET /api/portal/instance/property HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Result with an array of records
{
"result": {
"id": "text",
"name": "text",
"border_radius": "ROUND",
"text_color": "AUTO",
"widget_position": "LEFT",
"widget_font": "Georgia",
"primary_color": "#c3c3c3",
"default_notice_type": "CLASSIC",
"has_scripts": true,
"has_dsar": true,
"has_docs": true,
"has_accessibility": true,
"display_dpo": true,
"display_company": true,
"has_continuous_scanning": true,
"has_welcome_message": true,
"has_accessibility_icon": true,
"accessibility_phone": true,
"widget_icon": "text",
"logo_url": "https://example.com",
"logo_light_url": "https://example.com",
"description": "text",
"domains": [
{
"id": "text",
"name": "text",
"is_primary": true,
"created_at": "2025-11-13T00:13:23.025Z"
}
],
"representatives": [
{
"id": "text",
"type": "PERSON",
"email": "[email protected]",
"company_name": "text",
"first_name": "text",
"last_name": "text",
"position": "text",
"description": "text",
"avatar_url": "https://example.com",
"category": "text",
"jurisdiction": [
"text"
],
"address": {
"id": "text",
"country": "RO",
"state": "text",
"address": "text",
"address_2": "text",
"postal_code": "text",
"phone_number": 40755111222
},
"created_at": "2025-11-13T00:13:23.025Z"
}
],
"default_language": {
"id": "text",
"code": "text",
"name": "text"
},
"features": {}
}
}Change property information and configuration
API key generated in Clym Partner Portal.
Either a merchant ID or a domain ID is required
The new border radius applied on UI elements in the widget and governance portal
The new text color to apply on UI elements
The new side of the page the widget will position itself
Specify the custom font that will be applied to the widget
GeorgiaThe new primary color of the widget and governance portal
#c3c3c3The new default notice type to be used by the widget
If set to false, the widget will not handle any kind of consent/cookie management and will not block any scripts
If set to false, the widget and governance portal will not handle any kind of data subject requests.
If set to false, the widget and governance portal will not display any legal documents
If set to false, the widget will not provide any accessibility functionality
If set to false, the widget and governance portal will not display any representative information
If set to false, the widget and governance portal will not display any company information
Specifies if the widget has continuous scanning enabled
Specifies if the welcome message should be displayed in the widget
The widget will use the accessibility icon for jurisdictions that do not require cookie consent
The accessibility phone number configured for the accessibility widget
The default widget opening icon
circle-checkThe new welcome message used by the widget
The new default language code of the widget
HUThe previously uploaded logo id
The previously uploaded light logo id
Result with an array of records
PUT /api/portal/instance/property HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 519
{
"border_radius": "ROUND",
"text_color": "AUTO",
"widget_position": "LEFT",
"widget_font": "Georgia",
"primary_color": "#c3c3c3",
"default_notice_type": "CLASSIC",
"has_scripts": true,
"has_dsar": true,
"has_docs": true,
"has_accessibility": true,
"display_dpo": true,
"display_company": true,
"has_continuous_scanning": true,
"has_welcome_message": true,
"has_accessibility_icon": true,
"accessibility_phone": true,
"widget_icon": "circle-check",
"description": "text",
"lang": "HU",
"logo_url": "https://example.com",
"logo_light_url": "https://example.com"
}Result with an array of records
{
"result": {
"id": "text",
"name": "text",
"border_radius": "ROUND",
"text_color": "AUTO",
"widget_position": "LEFT",
"widget_font": "Georgia",
"primary_color": "#c3c3c3",
"default_notice_type": "CLASSIC",
"has_scripts": true,
"has_dsar": true,
"has_docs": true,
"has_accessibility": true,
"display_dpo": true,
"display_company": true,
"has_continuous_scanning": true,
"has_welcome_message": true,
"has_accessibility_icon": true,
"accessibility_phone": true,
"widget_icon": "text",
"logo_url": "https://example.com",
"logo_light_url": "https://example.com",
"description": "text",
"domains": [
{
"id": "text",
"name": "text",
"is_primary": true,
"created_at": "2025-11-13T00:13:23.025Z"
}
],
"representatives": [
{
"id": "text",
"type": "PERSON",
"email": "[email protected]",
"company_name": "text",
"first_name": "text",
"last_name": "text",
"position": "text",
"description": "text",
"avatar_url": "https://example.com",
"category": "text",
"jurisdiction": [
"text"
],
"address": {
"id": "text",
"country": "RO",
"state": "text",
"address": "text",
"address_2": "text",
"postal_code": "text",
"phone_number": 40755111222
},
"created_at": "2025-11-13T00:13:23.025Z"
}
],
"default_language": {
"id": "text",
"code": "text",
"name": "text"
},
"features": {}
}
}This API endpoint is used to send implementation instructions to the specified email address
API key generated in Clym Partner Portal.
Either a merchant ID or a domain ID is required
The email address to send the implementation instructions
Additional information to be included in the email
Request completed successfully
POST /api/portal/instance/property/send-instructions HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"email": "[email protected]",
"message": "text"
}Request completed successfully
{
"result": {}
}Prepares a signed URL for a logo, logo_light or favicon to be uploaded for the property.
API key generated in Clym Partner Portal.
Either a merchant ID or a domain ID is required
The asset type you want to upload
The mime type of the asset you want to upload
image/pngResult with the added property domain
POST /api/portal/instance/property/sign-asset HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 34
{
"type": "logo",
"mime": "image/png"
}Result with the added property domain
{
"result": {
"url": "https://example.com"
}
}This API endpoint is used when you want to remove a previously uploaded asset from the property.
API key generated in Clym Partner Portal.
Either a merchant ID or a domain ID is required
Request completed successfully
DELETE /api/portal/instance/property/image/{type} HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Request completed successfully
{
"result": {}
}Retrieve a list of available domains for this property
API key generated in Clym Partner Portal.
Either a merchant ID or a domain ID is required
Result with an array of property domains
GET /api/portal/instance/property/domains HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Result with an array of property domains
{
"meta": {
"current_page": 1,
"next_page": 1,
"prev_page": 1
},
"result": {
"id": "text",
"name": "text",
"is_primary": true,
"created_at": "2025-11-13T00:13:23.025Z"
}
}Create a new domain for this property
API key generated in Clym Partner Portal.
Either a merchant ID or a domain ID is required
The full domain hostname to be added
mydomain.comResult with the added property domain
POST /api/portal/instance/property/domains HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 23
{
"name": "mydomain.com"
}Result with the added property domain
{
"result": {
"id": "text",
"name": "text",
"is_primary": true,
"created_at": "2025-11-13T00:13:23.025Z"
}
}Deletes the specified property domain
API key generated in Clym Partner Portal.
The property domain id
Either a merchant ID or a domain ID is required
Request completed successfully
DELETE /api/portal/instance/property/domains/{id} HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
Request completed successfully
{}Last updated