Skip to content
Clym

API reference

Governance portal settings

Operations for governance portal settings

Read gov portal settings

GET

Retrieve governance portal settings

Path parameters:

Name Type Required Description
property_id string Yes
200Gov portal settingsapplication/json
resultobjectoptional
Government portal settings
Show properties
gov_portal_enabledobjectoptional
Individual setting field with metadata
Show properties
idintegeroptional
namestringoptional
valuestring | boolean | integer | number | any[]optional
allowed_valuesstring[]optional
feature_flagstringoptional
can_changebooleanoptional
title_textobjectoptional
Individual setting field with metadata
Show properties
idintegeroptional
namestringoptional
valuestring | boolean | integer | number | any[]optional
allowed_valuesstring[]optional
feature_flagstringoptional
can_changebooleanoptional
subtitle_textobjectoptional
Individual setting field with metadata
Show properties
idintegeroptional
namestringoptional
valuestring | boolean | integer | number | any[]optional
allowed_valuesstring[]optional
feature_flagstringoptional
can_changebooleanoptional
display_privacyobjectoptional
Individual setting field with metadata
Show properties
idintegeroptional
namestringoptional
valuestring | boolean | integer | number | any[]optional
allowed_valuesstring[]optional
feature_flagstringoptional
can_changebooleanoptional
title_colorobjectoptional
Individual setting field with metadata
Show properties
idintegeroptional
namestringoptional
valuestring | boolean | integer | number | any[]optional
allowed_valuesstring[]optional
feature_flagstringoptional
can_changebooleanoptional
subtitle_colorobjectoptional
Individual setting field with metadata
Show properties
idintegeroptional
namestringoptional
valuestring | boolean | integer | number | any[]optional
allowed_valuesstring[]optional
feature_flagstringoptional
can_changebooleanoptional
privacy_policiesobjectoptional
Individual setting field with metadata
Show properties
idintegeroptional
namestringoptional
valuestring | boolean | integer | number | any[]optional
allowed_valuesstring[]optional
feature_flagstringoptional
can_changebooleanoptional
legal_documentsobjectoptional
Individual setting field with metadata
Show properties
idintegeroptional
namestringoptional
valuestring | boolean | integer | number | any[]optional
allowed_valuesstring[]optional
feature_flagstringoptional
can_changebooleanoptional
hero_image_urlobjectoptional
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
logo_light_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/gov-portal
GET /api/{property_id}/settings/gov-portal HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Gov portal settings
{
  "result": {
    "gov_portal_enabled": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "title_text": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "subtitle_text": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "display_privacy": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "title_color": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "subtitle_color": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "privacy_policies": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "legal_documents": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    },
    "hero_image_url": {
      "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
    },
    "logo_light_url": {
      "id": 0,
      "name": "string",
      "value": null,
      "allowed_values": ["string"],
      "feature_flag": "string",
      "can_change": false
    }
  }
}

Save gov portal settings

POST

Update governance portal 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/gov-portal
POST /api/{property_id}/settings/gov-portal 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 gov portal 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/gov-portal/sign-asset
POST /api/{property_id}/settings/gov-portal/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"
  }
}

Find domain aliases

GET

Retrieve domain aliases for governance portal

Path parameters:

Name Type Required Description
property_id string Yes
200List of domain aliasesapplication/json
resultobject[]optional
Show properties
idstringoptional
hostnamestringoptional
typestringenumoptional
Possible values: COMPLIANCE_CENTER
is_verifiedbooleanoptional
verification_tokenstringoptional
created_atstringoptional
get/{property_id}/settings/gov-portal/domains
GET /api/{property_id}/settings/gov-portal/domains HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200List of domain aliases
{
  "result": [{
    "id": "string",
    "hostname": "portal.example.com",
    "type": "COMPLIANCE_CENTER",
    "is_verified": false,
    "verification_token": "string",
    "created_at": "string"
  }]
}

Create domain alias

POST

Add a new domain alias for governance portal

Path parameters:

Name Type Required Description
property_id string Yes
Request bodyapplication/json
hostnamestringrequired
200Created domain aliasapplication/json
resultobjectoptional
Show properties
idstringoptional
hostnamestringoptional
typestringenumoptional
Possible values: COMPLIANCE_CENTER
is_verifiedbooleanoptional
verification_tokenstringoptional
created_atstringoptional
post/{property_id}/settings/gov-portal/domains
POST /api/{property_id}/settings/gov-portal/domains HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*

{
  "hostname": "portal.example.com"
}
200Created domain alias
{
  "result": {
    "id": "string",
    "hostname": "portal.example.com",
    "type": "COMPLIANCE_CENTER",
    "is_verified": false,
    "verification_token": "string",
    "created_at": "string"
  }
}

Verify domain alias

POST

Verify domain ownership via DNS token

Path parameters:

Name Type Required Description
property_id string Yes
id string Yes
200Verification resultapplication/json
resultobjectoptional
Show properties
verifiedbooleanoptional
post/{property_id}/settings/gov-portal/domains/{id}/verify
POST /api/{property_id}/settings/gov-portal/domains/{id}/verify HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Verification result
{
  "result": {
    "verified": false
  }
}

Delete domain alias

DELETE

Remove a domain alias

Path parameters:

Name Type Required Description
property_id string Yes
id string Yes
200Deletion confirmationapplication/json
resultobjectoptional
Show properties
deletedbooleanoptional
delete/{property_id}/settings/gov-portal/domains/{id}
DELETE /api/{property_id}/settings/gov-portal/domains/{id} HTTP/1.1
Host: {instance}.clym.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200Deletion confirmation
{
  "result": {
    "deleted": false
  }
}

© 2026 ClymTermsPrivacy policyCookie policy