API reference

Widget settings

Operations for widget settings

Read widget settings

GET

Retrieve widget platform settings

Path parameters:

Name	Type	Required	Description
`property_id`	string	Yes

200Widget settingsapplication/json

resultobjectoptional

Widget platform settings

Show properties

has_dsarobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

valuestring | boolean | integer | number | any[]optional

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

has_accessibilityobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

valuestring | boolean | integer | number | any[]optional

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

default_notice_typeobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

valuestring | boolean | integer | number | any[]optional

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

blocking_modeobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

valuestring | boolean | integer | number | any[]optional

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

widget_executionobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

valuestring | boolean | integer | number | any[]optional

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

script_delayobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

valuestring | boolean | integer | number | any[]optional

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

greeting_textobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

valuestring | boolean | integer | number | any[]optional

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

intro_messageobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

valuestring | boolean | integer | number | any[]optional

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

native_noticeobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

valuestring | boolean | integer | number | any[]optional

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

client_side_consent_resolutionobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

valuestring | boolean | integer | number | any[]optional

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

logo_displayobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

valuestring | boolean | integer | number | any[]optional

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

accessibility_phoneobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

valuestring | boolean | integer | number | any[]optional

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

legal_searchobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

valuestring | boolean | integer | number | any[]optional

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

widget_iconobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

valuestring | boolean | integer | number | any[]optional

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

use_accessibility_iconobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

valuestring | boolean | integer | number | any[]optional

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

primary_colorobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

valuestring | boolean | integer | number | any[]optional

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

logo_urlobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

valuestring | boolean | integer | number | any[]optional

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

favicon_urlobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

valuestring | boolean | integer | number | any[]optional

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

get/{property_id}/settings/widget

GET /api/{property_id}/settings/widget HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Widget settings

{
  "result": {
    "has_dsar": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "has_accessibility": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "default_notice_type": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "blocking_mode": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "widget_execution": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "script_delay": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "greeting_text": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "intro_message": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "native_notice": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "client_side_consent_resolution": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "logo_display": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "accessibility_phone": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "legal_search": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "widget_icon": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "use_accessibility_icon": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "primary_color": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "logo_url": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "favicon_url": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    }
  }
}

Save widget settings

POST

Update widget platform settings

Path parameters:

Name	Type	Required	Description
`property_id`	string	Yes

Request bodyapplication/json

settingsobjectrequired

200Settings updatedapplication/json

resultobjectoptional

Show properties

changedboolean | string[]optional

post/{property_id}/settings/widget

POST /api/{property_id}/settings/widget HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*

{
  "settings": {}
}

200Settings updated

{
  "result": {
    "changed": null
  }
}

Sign asset upload

POST

Generate signed URL for uploading widget assets

Path parameters:

Name	Type	Required	Description
`property_id`	string	Yes

Request bodyapplication/json

mimestringrequired

fieldstringrequired

200Upload URL generatedapplication/json

resultobjectoptional

Show properties

urlstringoptional

attachment_idstringoptional

expires_atstringoptional

post/{property_id}/settings/widget/sign-asset

POST /api/{property_id}/settings/widget/sign-asset HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*

{
  "mime": "string",
  "field": "string"
}

200Upload URL generated

{
  "result": {
    "url": "string",
    "attachment_id": "string",
    "expires_at": "string"
  }
}

Remove widget asset

DELETE

Remove an uploaded widget asset

Path parameters:

Name	Type	Required	Description
`property_id`	string	Yes

Request bodyapplication/json

fieldstringrequired

200Asset removedapplication/json

resultobjectoptional

Show properties

removedbooleanoptional

delete/{property_id}/settings/widget/remove-asset

DELETE /api/{property_id}/settings/widget/remove-asset HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*

{
  "field": "logo_url"
}

200Asset removed

{
  "result": {
    "removed": false
  }
}