API Reference

Learn how to access UNLOQ end points

POST /widgets

Create a new widget

POST https://api.unloq.io/v1/widgets
Headers:
   Authorization: Bearer {your application API Key}
   Content-Type: application/json
Body parameters
  • environment (enum) - Required. 'LIVE' or 'SANDBOX'
  • name (string) - Optional. Name of the widget
  • lang (enum) - Optional. Default value is 'en'
  • type (enum) - Required. Available options are ['LOGIN', 'CONFIRMATION', 'DEACTIVATE', 'REGISTER', 'LOGOUT']
  • is_active (boolean) - Optional. Default value is 'TRUE'
  • url (string) - Required. The full domain url.
  • color_primary (string) - Optional. Hex code for primary color.
  • color_secondary (string) - Optional. Hex code for secondary color.
  • color_link (string) - Optional. Hex code for links color.
  • has_watermark (boolean) - Optional. Default value is 'TRUE'
Result format (200 OK)
{
  "type": "api.application.widget.create",
  "result": {
    "id": "12345",
    "lang": "en",
    "name": "My widget",
    "type": "CONFIRMATION",
    "is_active": true,
    "has_watermark": true,
    "environment": "LIVE",
    "organization_id": "123",
    "application_id": "12",
    "created_at": "2016-11-23T14:03:51.000Z",
    "color": {
      "primary": "#5c5d5d",
      "secondary": "#000000",
      "link": "#3da0e3",
      "error": ""
    },
    "path": "/",
    "domain_id": "abcdef"
  }
}
      

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.