API reference

Global settings

Operations for global platform settings

Read global settings

GET

Retrieve global platform settings

Path parameters:

Name	Type	Required	Description
`property_id`	string	Yes

200Global settingsapplication/json

resultobjectoptional

Global platform settings

Show properties

iab_gpp_stubobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

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

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

iab_tcf_stubobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

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

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

google_consent_mode_defaultobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

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

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

gcm_wait_for_updateobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

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

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

gcm_default_granted_regionsobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

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

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

gcm_default_denied_regionsobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

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

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

microsoft_consent_mode_defaultobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

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

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

mcm_wait_for_updateobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

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

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

mcm_default_granted_regionsobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

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

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

mcm_default_denied_regionsobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

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

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

has_realtime_complianceobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

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

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

realtime_scan_periodobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

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

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

realtime_scan_percent_createobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

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

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

realtime_scan_percent_removeobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

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

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

has_realtime_implementation_check_notificationobjectoptional

Individual setting field with metadata

Show properties

idintegeroptional

namestringoptional

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

allowed_valuesstring[]optional

feature_flagstringoptional

can_changebooleanoptional

dsr_bottom_info_textobjectoptional

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/global

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

200Global settings

{
  "result": {
    "iab_gpp_stub": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "iab_tcf_stub": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "google_consent_mode_default": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "gcm_wait_for_update": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "gcm_default_granted_regions": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "gcm_default_denied_regions": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "microsoft_consent_mode_default": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "mcm_wait_for_update": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "mcm_default_granted_regions": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "mcm_default_denied_regions": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "has_realtime_compliance": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "realtime_scan_period": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "realtime_scan_percent_create": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "realtime_scan_percent_remove": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "has_realtime_implementation_check_notification": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "dsr_bottom_info_text": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    }
  }
}

Save global settings

POST

Update global 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/global

POST /api/{property_id}/settings/global 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 global settings 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/global/sign-asset

POST /api/{property_id}/settings/global/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"
  }
}