POST/v1/Client

Create Client

Not yet documented — no summary in the API source.

RequiresAuthorization: Bearer sk_...tenant_id

Request body application/json

namestringrequiredmin length 1
email_addressstringnullablepattern ^[\w!#$%&'*+\-\/=?^`{|}~]+(\.{0,2}[\w!#$%&'*+\-\/=?^`{|}~]+)*\@([a-zA-Z0-9\-_]+\.?)*([a-zA-Z0-9\-_]{1,}\.[a-zA-Z0-9\-_]{1,})$
first_namestringnullable
last_namestringnullable
sample_databoolean
tenant_suffixstringnullable
existing_userboolean
external_idstringrequiredmin length 1
aliasstringnullable
bulk_request_delivery_methodstringnullable
bulk_request_delivery_typestringnullable
explicit_permission_typesarray of objectClientLawConfigurationExplicitTypenullable
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

Responses

clientobjectClient
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
permission_categoriesarray of objectPermissionCategorynullable
compliance_input_typesarray of stringnullable
custom_field_configobjectClientCustomFieldConfiguration
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
clientUserobjectClientUser
idstringnullable
tenant_idstringnullable
created_atstring (date-time)
updated_atstring (date-time)
email_addressstringrequiredmin length 1pattern ^[\w!#$%&'*+\-\/=?^`{|}~]+(\.{0,2}[\w!#$%&'*+\-\/=?^`{|}~]+)*\@([a-zA-Z0-9\-_]+\.?)*([a-zA-Z0-9\-_]{1,}\.[a-zA-Z0-9\-_]{1,})$
first_namestringrequiredmin length 1
last_namestringrequiredmin length 1
user_levelstringrequiredmin length 1
external_idstringnullable
is_original_userboolean
permissionsfree-form JSONClientUserPermissions

Any JSON value. Not validated against a schema.

curl --request POST \
  --url 'https://api.4comply.io/v1/Client' \
  --header 'Authorization: Bearer sk_...' \
  --header 'tenant_id: your-tenant-id' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example name",
  "email_address": "user@example.com",
  "first_name": "Example name",
  "last_name": "Example name",
  "sample_data": true,
  "tenant_suffix": "your-tenant",
  "existing_user": true,
  "external_id": "00000000-0000-0000-0000-000000000000",
  "alias": "Example name",
  "bulk_request_delivery_method": "string",
  "bulk_request_delivery_type": "string",
  "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"
  ]
}'