HomeKnowledge baseGovernance portalSign inStart free trial

Property

The following endpoints allow you to view and manage the specified merchant/domain's property configuration and widget settings.

Get property

get

Retrieve the property information and configuration

Authorizations
Query parameters
merchant_idstringOptional

Either a merchant ID or a domain ID is required

domain_idstringOptional
Responses
200

Result with an array of records

application/json
get
GET /api/portal/instance/property HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

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-08-14T14:08:20.315Z"
      }
    ],
    "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-08-14T14:08:20.315Z"
      }
    ],
    "default_language": {
      "id": "text",
      "code": "text",
      "name": "text"
    },
    "features": {}
  }
}

Update property

put

Change property information and configuration

Authorizations
Query parameters
merchant_idstringOptional

Either a merchant ID or a domain ID is required

domain_idstringOptional
Body
border_radiusstring · enumOptional

The new border radius applied on UI elements in the widget and governance portal

Possible values:
text_colorstring · enumOptional

The new text color to apply on UI elements

Possible values:
widget_positionstring · enumOptional

The new side of the page the widget will position itself

Possible values:
widget_fontstringOptional

Specify the custom font that will be applied to the widget

Example: Georgia
primary_colorstringOptional

The new primary color of the widget and governance portal

Example: #c3c3c3
default_notice_typestring · enumOptional

The new default notice type to be used by the widget

Possible values:
has_scriptsbooleanOptional

If set to false, the widget will not handle any kind of consent/cookie management and will not block any scripts

has_dsarbooleanOptional

If set to false, the widget and governance portal will not handle any kind of data subject requests.

has_docsbooleanOptional

If set to false, the widget and governance portal will not display any legal documents

has_accessibilitybooleanOptional

If set to false, the widget will not provide any accessibility functionality

display_dpobooleanOptional

If set to false, the widget and governance portal will not display any representative information

display_companybooleanOptional

If set to false, the widget and governance portal will not display any company information

has_continuous_scanningbooleanOptional

Specifies if the widget has continuous scanning enabled

has_welcome_messagebooleanOptional

Specifies if the welcome message should be displayed in the widget

has_accessibility_iconbooleanOptional

The widget will use the accessibility icon for jurisdictions that do not require cookie consent

accessibility_phonebooleanOptional

The accessibility phone number configured for the accessibility widget

widget_iconstringOptional

The default widget opening icon

Example: circle-check
descriptionstringOptional

The new welcome message used by the widget

langstringOptional

The new default language code of the widget

Example: HU
logo_urlstring · uriOptional

The previously uploaded logo id

logo_light_urlstring · uriOptional

The previously uploaded light logo id

Responses
200

Result with an array of records

application/json
put
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"
}
200

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-08-14T14:08:20.315Z"
      }
    ],
    "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-08-14T14:08:20.315Z"
      }
    ],
    "default_language": {
      "id": "text",
      "code": "text",
      "name": "text"
    },
    "features": {}
  }
}

Send instructions

post

This API endpoint is used to send implementation instructions to the specified email address

Authorizations
Query parameters
merchant_idstringOptional

Either a merchant ID or a domain ID is required

domain_idstringOptional
Body
emailstring · emailRequired

The email address to send the implementation instructions

messagestringOptional

Additional information to be included in the email

Responses
200

Request completed successfully

application/json
post
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"
}
200

Request completed successfully

{
  "result": {}
}

Sign asset

post

Prepares a signed URL for a logo, logo_light or favicon to be uploaded for the property.

Authorizations
Query parameters
merchant_idstringOptional

Either a merchant ID or a domain ID is required

domain_idstringOptional
Body
typestring · enumRequired

The asset type you want to upload

Possible values:
mimestringRequired

The mime type of the asset you want to upload

Example: image/png
Responses
200

Result with the added property domain

application/json
post
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"
}
200

Result with the added property domain

{
  "result": {
    "url": "https://example.com"
  }
}

Delete asset

delete

This API endpoint is used when you want to remove a previously uploaded asset from the property.

Authorizations
Path parameters
typestring · enumRequiredPossible values:
Query parameters
merchant_idstringOptional

Either a merchant ID or a domain ID is required

domain_idstringOptional
Responses
200

Request completed successfully

application/json
delete
DELETE /api/portal/instance/property/image/{type} HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Request completed successfully

{
  "result": {}
}

Get domains

get

Retrieve a list of available domains for this property

Authorizations
Query parameters
merchant_idstringOptional

Either a merchant ID or a domain ID is required

domain_idstringOptional
Responses
200

Result with an array of property domains

application/json
get
GET /api/portal/instance/property/domains HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

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-08-14T14:08:20.315Z"
  }
}

Create domain

post

Create a new domain for this property

Authorizations
Query parameters
merchant_idstringOptional

Either a merchant ID or a domain ID is required

domain_idstringOptional
Body
namestring · uriRequired

The full domain hostname to be added

Example: mydomain.com
Responses
200

Result with the added property domain

application/json
post
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"
}
200

Result with the added property domain

{
  "result": {
    "id": "text",
    "name": "text",
    "is_primary": true,
    "created_at": "2025-08-14T14:08:20.315Z"
  }
}

Delete domain

delete

Deletes the specified property domain

Authorizations
Path parameters
idstringRequired

The property domain id

Query parameters
merchant_idstringOptional

Either a merchant ID or a domain ID is required

domain_idstringOptional
Responses
200

Request completed successfully

application/json
Responseobject
delete
DELETE /api/portal/instance/property/domains/{id} HTTP/1.1
Host: partners.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

Request completed successfully

{}
PreviousRecordsNextWebhook Reference

Last updated