---
title: "aid_customers_atributes_put"
method: PUT
path: "/accounts/{aid}/customers/settings"
tags: ["settings"]
---

# aid_customers_atributes_put

`PUT /accounts/{aid}/customers/settings`

Update customers settings

scopes:
- admin:customers
- write:customers

## Path parameters

- `aid` string, ^[PT]{1}\d{8}$, required

## Request body

- CustomersSettings — Customer settings for the account
  - `users` object — customers user configurations
    - `head` object — Enable endpoint [HEAD /customers/users endpoint](/customers-api/users/aid_customers_head)
      - `enabled` boolean, required
    - `phone_number_validation` object — Configuration validation of user phone_number
      - `allow_duplicates` boolean, required — Allow multiple users to share the same phone number. Passwordless login with OTP sent via SMS is not supported when enabled.
    - `customer_id_format` 'uuid' | 'sequence', required — Format used when generating a customer_id when new user is created. - **uuid**: customer_id generated will be a random UUID - **sequence**: customer_id generated will be serial. The initial start value will be the current maximum + 1 of existing customer_ids. > **Note**: New customers should not be created with customer_id set when `sequence` format is used as it can introduce conflicts later when creating user without specifying customer_id
    - `mfa` CustomersMfaSettings — enable mfa login
      - `enabled` boolean, required — Use this setting to enable mfa for customers login. When mfa is enabled the mfa_login endpoint has to be used for logging in.
      - `login` object, required — mfa login
        - `challenge_type` 'oob', required
        - `oob_channel` 'sms' | 'email', required
      - `login_recovery` object, required — mfa login recovery
        - `challenge_type` 'oob', required
        - `oob_channel` 'sms' | 'email', required
    - `verifications` object — Enable verifications on user updates.
      - `phone_number` 'sms' — Require verification to update user phone_number
  - `auto_tokens` object — Automatically generate tokens for these properties on the customer
    - `phone_number` AutoTokenType[]
      - `type` 'SHA256' | 'HMAC-SHA256', required
    - `email` AutoTokenType[]
      - `type` 'SHA256' | 'HMAC-SHA256', required
  - `tokens` object — tokens configuration
    - `event_expiry` object[] — configure the expire behaviour of token events
      - `status` string, required — the event status to configure TTL on
      - `time_to_live` integer, required — Time-To-Live (TTL) for for the token event status in seconds
  - `attributes` object[] — user attributes
    - `name` string, required — name of the attribute
    - `type` 'string' | 'integer' | 'real' | 'boolean' | 'phonenumber' | 'email' | 'date' | 'date-time', required — type of the attribute value
    - `multiple_values` boolean — agreement (true/false) to enter multiple values
    - `private` boolean — agreement (true/false) for visibility for customers

## Response `200`

added/updated object of customers settings

- CustomersSettings — Customer settings for the account
  - `users` object — customers user configurations
    - `head` object — Enable endpoint [HEAD /customers/users endpoint](/customers-api/users/aid_customers_head)
      - `enabled` boolean, required
    - `phone_number_validation` object — Configuration validation of user phone_number
      - `allow_duplicates` boolean, required — Allow multiple users to share the same phone number. Passwordless login with OTP sent via SMS is not supported when enabled.
    - `customer_id_format` 'uuid' | 'sequence', required — Format used when generating a customer_id when new user is created. - **uuid**: customer_id generated will be a random UUID - **sequence**: customer_id generated will be serial. The initial start value will be the current maximum + 1 of existing customer_ids. > **Note**: New customers should not be created with customer_id set when `sequence` format is used as it can introduce conflicts later when creating user without specifying customer_id
    - `mfa` CustomersMfaSettings — enable mfa login
      - `enabled` boolean, required — Use this setting to enable mfa for customers login. When mfa is enabled the mfa_login endpoint has to be used for logging in.
      - `login` object, required — mfa login
        - `challenge_type` 'oob', required
        - `oob_channel` 'sms' | 'email', required
      - `login_recovery` object, required — mfa login recovery
        - `challenge_type` 'oob', required
        - `oob_channel` 'sms' | 'email', required
    - `verifications` object — Enable verifications on user updates.
      - `phone_number` 'sms' — Require verification to update user phone_number
  - `auto_tokens` object — Automatically generate tokens for these properties on the customer
    - `phone_number` AutoTokenType[]
      - `type` 'SHA256' | 'HMAC-SHA256', required
    - `email` AutoTokenType[]
      - `type` 'SHA256' | 'HMAC-SHA256', required
  - `tokens` object — tokens configuration
    - `event_expiry` object[] — configure the expire behaviour of token events
      - `status` string, required — the event status to configure TTL on
      - `time_to_live` integer, required — Time-To-Live (TTL) for for the token event status in seconds
  - `attributes` object[] — user attributes
    - `name` string, required — name of the attribute
    - `type` 'string' | 'integer' | 'real' | 'boolean' | 'phonenumber' | 'email' | 'date' | 'date-time', required — type of the attribute value
    - `multiple_values` boolean — agreement (true/false) to enter multiple values
    - `private` boolean — agreement (true/false) for visibility for customers

## Other responses

- `400` — Bad / Invalid request
- `401` — Access forbidden, invalid JWT token was used
- `403` — Forbidden
- `500` — Unexpected Error

---

[API](https://skmtc.net/dintero/apis/account-management-api.md) · [All operations](https://skmtc.net/dintero/apis/account-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dintero/account-management-api/revisions/9b83a4199008/schema)