PUT/v1/preferencepages/{id}

Update preferencepages

Not yet documented — no summary in the API source.

RequiresAuthorization: Bearer sk_...tenant_id

Path parameters

idstringrequired

Request body application/json

idstringnullable
tenant_idstringnullable
created_atstring (date-time)
updated_atstring (date-time)
namestringnullablemax length 64
descriptionstringnullablemax length 512
statusstringnullable
form_Idstringnullable
htmlstringnullable
headerHtmlstringnullable
footerHtmlstringnullable
customCssstringnullable
headerScriptstringnullable
footerScriptstringnullable
businessUnitstringnullable
i18n_languagestringnullable
uiTranslationsobjectnullable
{key}objectnullable
{key}string
includeEmailSearchboolean
includeUnsubscribeboolean
redirectUrlstringnullable
generalCorePreferencesarray of objectGeneralCorePreferencenullable
idstringnullable
tenant_idstringnullable
created_atstring (date-time)
updated_atstring (date-time)
typestringnullable
orderinteger (int32)
cssClassstringnullable
formIdstringnullable
controlIdstringnullable
contentstringnullable
translationsobjectnullable
{key}stringnullable
controlNamestringnullable
controlHtmlstringnullable
childrenarray of GeneralCorePreferenceGeneralCorePreferencenullable
is_deletedboolean
deleted_atstring (date-time)nullable

Responses

No response body.

curl --request PUT \
  --url 'https://api.4comply.io/v1/preferencepages/00000000-0000-0000-0000-000000000000' \
  --header 'Authorization: Bearer sk_...' \
  --header 'tenant_id: your-tenant-id' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "00000000-0000-0000-0000-000000000000",
  "tenant_id": "your-tenant-id",
  "created_at": "2026-09-07T12:00:00Z",
  "updated_at": "2026-09-07T12:00:00Z",
  "name": "Example name",
  "description": "Example text",
  "status": "active",
  "form_Id": "00000000-0000-0000-0000-000000000000",
  "html": "string",
  "headerHtml": "string",
  "footerHtml": "string",
  "customCss": "string",
  "headerScript": "string",
  "footerScript": "string",
  "businessUnit": "string",
  "i18n_language": "en",
  "uiTranslations": {
    "en": {
      "en": "string"
    }
  },
  "includeEmailSearch": true,
  "includeUnsubscribe": true,
  "redirectUrl": "https://example.com",
  "generalCorePreferences": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "tenant_id": "your-tenant-id",
      "created_at": "2026-09-07T12:00:00Z",
      "updated_at": "2026-09-07T12:00:00Z",
      "type": "string",
      "order": 1,
      "cssClass": "string",
      "formId": "00000000-0000-0000-0000-000000000000",
      "controlId": "00000000-0000-0000-0000-000000000000",
      "content": "Example text",
      "translations": {
        "en": "string"
      },
      "controlName": "Example name",
      "controlHtml": "string",
      "children": []
    }
  ],
  "is_deleted": true,
  "deleted_at": "2026-09-07T12:00:00Z"
}'