Update OTP Templates
  • 16 Feb 2024
  • 1 Minute to read

    Update OTP Templates


      Article Summary

      Overview

      The Verify API enables you to generate, send, and verify OTP codes for the SMS channel. 

      After you create a channel for your brand, you can edit and update its templates later.

      Endpoint and Headers

      POST https://verify.useinsider.com/v1/template/update

      Headers

      HeaderSample ValueDescription
      X-INS-AUTH-KEY1a2b3c4d5e6fThis key is required to authorize your request. Refer to API Authentication Tokens to generate your token.
      Content-Typeapplication/jsonThis header specifies the media type of the resource.

      Body Parameters

      ParameterDescriptionData TypeRequiredRules
      channelChannel that you will send the OTP code.StringYesoneof:sms
      localeDetermines the language/locale in which the OTP code message will be sent.StringYesoneof:de en es fr it ja nl pt ru tr
      textDefines the template text that will be used for generating OTP code messages.StringYesmax:100

      Sample Example

      Sample Request

      Every request made to the request endpoint requires a request body formatted in JSON and containing your parameters. 

      Your title goes here
      Make sure to replace the sample values in the request header(s) and body where required before sending your request.
      curl --location 'verify.useinsider.com/v1/template/update' \
      --header 'Content-Type: application/json' \
      --header 'x-ins-auth-key: 1a2b3c4d5e6f' \
      --data '{
          "channel": "sms",
          "locale": "en",
          "text": "Your {brandName} verification code is: {code}"
      }'

      Sample Responses

      202 Accepted

      This response indicates that your request was successfully completed.

      {
          "status": "success"
      }

      400 Bad Request

      {
          "errors": [
              {
                  "message": "invalid request payload"
              }
          ]
      }

      400 Bad Request

      {
          "errors": [
              {
                  "message": "this field is required",
                  "field": "text"
              }
          ]
      }

      401 Unauthorized

      {
          "errors": [
              {
                  "message": "unauthorized"
              }
          ]
      }

      409 Conflict

      {
          "errors": [
              {
                  "message": "no changes detected"
              }
          ]
      }

      429 Too Many Requests

      {
          "errors": [
              {
                  "message": "rate limit exceeded"
              }
          ]
      }

      500 Internal Service Error

      {
          "errors": [
              {
                  "message": "server error"
              }
          ]
      }

      Limitations

      • All functions must be executed with a simple HTTPS POST request.
      • The API Key should be provided as the authorization key on the request header. If the key is incorrect, the operation will not be executed and an authorization error will return in the response.

      Was this article helpful?


      ESC

      Eddy, a super-smart generative AI, opening up ways to have tailored queries and responses