Update customer's OTP settings

This endpoint allows you to update your OTP settings. You can configure SMS text template, language, callback, OTP code format and more through your OTP settings. The fetch available languages and SMS text templates use GET /api/v1/sms/otp/settings/languages and GET /api/v1/sms/otp/settings/templates.

Header Parameters

Authorization*string

Your API token

Request Body

application/json

OTP settings update parameters

callback_url?string

Optional parameter. Determines the URL where SMS OTP processing callbacks should be sent. If provided in OTP send requests, request-level callback_url overrides this setting.

client_name?string

Optional parameter. Determines the client name used by the SMS OTP processor. Usually this value is an email address or application identifier displayed in processing logs and callbacks.

code_formats?array<>

Optional parameter. Determines which character groups may be used during OTP code generation. If OTP code generation is performed on the client side, this setting is ignored, as the client provides the code. Supported formats are: "l" - letters in upper case; "n" – numbers; "s" - special characters.

code_generation_side?string

Optional parameter. Determines where the OTP code should be generated. If set to client, the OTP code must be provided in send requests. If set to service, the OTP code will be generated automatically by the platform.

Value in"client" | "service" | "default"

language?string

Optional parameter. Determines the default language used for OTP SMS messages. The value must be an ISO alpha-2 country code in lowercase format (for example: "en", "de", "fr"). Selected template must support the given language (if not, during SMS sending language will default to 'en'). Available languages can be fetched via GET /api/v1/sms/otp/settings/languages.

number_of_characters?integer

Optional parameter. Determines the generated OTP code length. The minimum allowed value is 4 characters.

Range4 <= value

request_data_send_back?boolean

Optional parameter. Determines whether request payload data should be included in responses and callbacks related to OTP sending operations.

sms_template_id?integer

Optional parameter. Determines which SMS template should be used for OTP messages. The value must contain a valid SMS template unique id, which can be fetched via GET /api/v1/sms/otp/settings/templates.

Range1 <= value

Response Body

`application/json`

curl -X PATCH "https://dev-refactor-api-e.voipenv.uk/api/v1/sms/otp/settings" \  -H "Authorization: string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "code": 0,
  "data": {
    "callback_url": "string",
    "client_name": "string",
    "code_formats": [
      "l"
    ],
    "code_generation_side": "client",
    "created_at": "string",
    "id": 0,
    "language": "string",
    "number_of_characters": 0,
    "request_data_send_back": true,
    "sms_template_id": 0
  },
  "error_details": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "message": "string",
  "request_id": "string",
  "status": "ok"
}

{
  "code": 0,
  "error_details": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "message": "string",
  "request_id": "string",
  "status": "error"
}

{
  "code": 0,
  "error_details": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "message": "string",
  "request_id": "string",
  "status": "error"
}

{
  "code": 0,
  "error_details": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "message": "string",
  "request_id": "string",
  "status": "error"
}

Update customer's OTP settings

Header Parameters

Request Body

Response Body

200application/json

400application/json

404application/json

500application/json

Contact us

`application/json`

`application/json`

`application/json`

`application/json`