PUT/v1/Client/{clientId}/alias

Update Client alias

Not yet documented — no summary in the API source.

RequiresAuthorization: Bearer sk_...tenant_id

Path parameters

clientIdstringrequired

Request body application/json

aliasstringnullable

Responses

idstringnullable
namestringnullable
tenant_suffixstringnullable
config_idobjectClientConfig
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
meteringobjectCounters
readRightsRequestinteger (int64)
writeRightsRequestinteger (int64)
writeConsentinteger (int64)
readConsentinteger (int64)
writePermissioninteger (int64)
readPermissioninteger (int64)
writeLegalActivityinteger (int64)
readLegalActivityinteger (int64)
writeLegalActivityErrorinteger (int64)
readLegalActivityErrorinteger (int64)
segments_tenant_idstringnullable
created_atstring (date-time)
updated_atstring (date-time)
is4ComplyEnabledboolean
is4PreferencesEnabledboolean
is4SegmentsEnabledboolean
curl --request PUT \
  --url 'https://api.4comply.io/v1/Client/00000000-0000-0000-0000-000000000000/alias' \
  --header 'Authorization: Bearer sk_...' \
  --header 'tenant_id: your-tenant-id' \
  --header 'Content-Type: application/json' \
  --data '{
  "alias": "Example name"
}'