API Reference

Learn how to access UNLOQ end points

POST /sms/templates

Create or update a template

POST https://api.unloq.io/v1/sms/templates
Headers:
   Authorization: Bearer {your application API Key}
   Content-Type: application/json

This endpoint is used to create or update templates. If a the code value included in the body parameters is new, a template will be created. If a template with that code already exists, it will be updated. If no code is provided, the default template will be updated

Body parameters
  • code (string) - Optional. Custom code for identifying templates. Eg. login, transaction template. If unset, the default template will be updated.
  • code_size (string) - Optional. The token size.
  • code_alpha (boolean) - Optional. If your token includes alpha characters.
  • code_numeric (boolean) - Optional. If your token includes numeric characters.
  • code_lowercase (boolean) - Optional. If your token includes lowercase alpha characters.
  • code_uppercase (boolean) - Optional. If your token includes uppercase alpha characters.
  • hide_phone_number (object) - Optional.
  • duration (enum) - Optional. The duration in seconds of the token's validity.
Result format (200 OK)
{
  "type": "api.application.sms.template.save",
  "result": {
    "code": "Transactions gtw",
    "code_size": 6,
    "code_alpha": true,
    "code_numeric": true,
    "code_lowercase": false,
    "code_uppercase": true,
    "hide_phone_number": true,
    "duration": 30,
    "created_at": "2017-12-18T11:13:14.000Z",
    "application_id": "5"
  }
}
      

Have a question? You can always send us an email at support@unloq.io, or contact us on chat.

For security related concerns, please visit our Security page.