PUT/v1/Client/{clientId}/permissiontypes

Update Client permissiontypes

Not yet documented — no summary in the API source.

RequiresAuthorization: Bearer sk_...tenant_id

Path parameters

clientIdstringrequired

Request body application/json

idstringnullable

tenant_idstringnullable

custom_email_domainstringnullable

client_logo_urlstringnullable

client_favicon_urlstringnullable

default_email_addressstringnullable

secondary_email_addressesarray of stringnullable

bulk_request_delivery_methodstringnullable

bulk_request_delivery_typestringnullable

permission_update_logicstringnullable

aliasstringnullable

explicit_permission_typesarray of objectClientLawConfigurationExplicitTyperequired

namestringrequiredmin length 1

descriptionstringnullable

default_permission_valuestringrequiredmin length 1

business_unitstringnullable

permission_categoriesarray of objectPermissionCategorynullable

idstringnullable

namestringrequiredmin length 1

compliance_input_typestringrequiredmin length 1

compliance_input_typesarray of stringnullable

custom_field_configobjectClientCustomFieldConfiguration

custom_field_1_namestringnullable

custom_field_2_namestringnullable

custom_field_3_namestringnullable

custom_field_4_namestringnullable

custom_field_5_namestringnullable

custom_field_6_namestringnullable

custom_field_7_namestringnullable

Responses

array of objectClientLawConfigurationExplicitType

namestringrequiredmin length 1

descriptionstringnullable

default_permission_valuestringrequiredmin length 1

business_unitstringnullable

Server

curl --request PUT \
  --url 'https://api.4comply.io/v1/Client/00000000-0000-0000-0000-000000000000/permissiontypes' \
  --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",
  "custom_email_domain": "user@example.com",
  "client_logo_url": "https://example.com",
  "client_favicon_url": "https://example.com",
  "default_email_address": "user@example.com",
  "secondary_email_addresses": [
    "user@example.com"
  ],
  "bulk_request_delivery_method": "string",
  "bulk_request_delivery_type": "string",
  "permission_update_logic": "string",
  "alias": "Example name",
  "explicit_permission_types": [
    {
      "name": "Example name",
      "description": "Example text",
      "default_permission_value": "string",
      "business_unit": "string"
    }
  ],
  "permission_categories": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Example name",
      "compliance_input_type": "string"
    }
  ],
  "compliance_input_types": [
    "string"
  ],
  "custom_field_config": {
    "custom_field_1_name": "Example name",
    "custom_field_2_name": "Example name",
    "custom_field_3_name": "Example name",
    "custom_field_4_name": "Example name",
    "custom_field_5_name": "Example name",
    "custom_field_6_name": "Example name",
    "custom_field_7_name": "Example name"
  }
}'

Credentials

Held in memory for this page only. Never stored.

Client key requiredYour 4Comply client key, sent as a bearer token.Tenant ID requiredIdentifies which tenant the request acts on.

Path parametersclientId required

Body

{
  "id": "00000000-0000-0000-0000-000000000000",
  "tenant_id": "your-tenant-id",
  "custom_email_domain": "user@example.com",
  "client_logo_url": "https://example.com",
  "client_favicon_url": "https://example.com",
  "default_email_address": "user@example.com",
  "secondary_email_addresses": [
    "user@example.com"
  ],
  "bulk_request_delivery_method": "string",
  "bulk_request_delivery_type": "string",
  "permission_update_logic": "string",
  "alias": "Example name",
  "explicit_permission_types": [
    {
      "name": "Example name",
      "description": "Example text",
      "default_permission_value": "string",
      "business_unit": "string"
    }
  ],
  "permission_categories": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Example name",
      "compliance_input_type": "string"
    }
  ],
  "compliance_input_types": [
    "string"
  ],
  "custom_field_config": {
    "custom_field_1_name": "Example name",
    "custom_field_2_name": "Example name",
    "custom_field_3_name": "Example name",
    "custom_field_4_name": "Example name",
    "custom_field_5_name": "Example name",
    "custom_field_6_name": "Example name",
    "custom_field_7_name": "Example name"
  }
}