Update email OTP settings

Turns the Email OTP Gate on (requires a verified SMTP configuration and an active template, else 422 email-otp-not-configured) or off, and sets how long a visitor stays signed in after verifying their email (sessionDurationMinutes, 15 to 1440). Both fields are optional. Turning the gate off keeps existing email-otp links active, but their landing pages stop sending new OTP emails. See Email OTP links.

Required permissions: manage-consumer-email · API keys: allowed · Recent sign-in: required for dashboard users (15 minutes)

PATCH /consumer/v1/email-otp-settings

cURL

turnOn

curl --request PATCH \
  --url https://api.voucher-staging.allride.io/consumer/v1/email-otp-settings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "emailOtpLinksEnabled": true
}
'

200

default

{
  "data": {
    "resource": "email-otp-settings",
    "emailOtpLinksEnabled": true,
    "ready": true,
    "missing": [],
    "smtpConfigurationStatus": "verified",
    "activeEmailTemplateId": 18017,
    "activeEmailOtpLinkCount": 4,
    "sessionDurationMinutes": 30,
    "_links": {
      "self": {
        "href": "https://api.voucher.allride.io/consumer/v1/email-otp-settings",
        "type": "application/json"
      },
      "smtpConfiguration": {
        "href": "https://api.voucher.allride.io/partner/v1/smtp-configuration",
        "type": "application/json"
      },
      "activeEmailTemplate": {
        "href": "https://api.voucher.allride.io/partner/v1/email-templates/18017",
        "type": "application/json"
      }
    }
  }
}

Authorizations

Authorization · string · header · required

Your API key in Authorization: Bearer <key>. Use vk_test_… keys against the sandbox and vk_live_… keys against production.

Body

application/json

emailOtpLinksEnabled · boolean

Turn the gate on (requires ready) or off.

sessionDurationMinutes · integer

Session length after email verification, in minutes (15 to 1440). Applies to visitors who verify after the change; sessions already verified keep their end time.

Required range: 15 <= x <= 1440

Response

200

application/json

OK

Single-object envelope around a EmailOtpSettings.

data · object · required

Email OTP Gate settings and readiness.

Show child attributes