API Reference

Learn how to access UNLOQ end points

PUT /sms/providers/:id

Update a provider

PUT https://api-authenticator.iwelcome.com/v1/sms/providers/:id
   Authorization: Bearer {your application API Key}
   Content-Type: application/json
URL parameters
  • id (string, required) - The provider id to be updated.
Body parameters
  • name (string, optional) - The name of the provider.
  • countries (array, optional) - The country codes where the provider will be used.
  • patterns (array, optional) - The phone number patterns that will use this provider.
  • phone_types (array, optional) - The phone types where the provider will be used. To check the supported phone types for the current provider check phonetypes find.
  • is_default (boolean, optional) - Make this the default provider.
  • is_active (boolean, optional) - Activate or deactivate the current provider.
  • sort (enum, optional) - Options are: "UP", "DOWN. Used for sorting the providers list.
  • log_messages (enum, optional) - Options are: "FULL", "HASH", "DISABLED.
Result format (200 OK)
  "type": "api.application.sms.provider.update",
  "result": {
    "id": "c3f78592588c4ce68ee6c96f6ZL2MKcF",
    "type": "NEXMO",
    "name": "New name",
    "log_messages": "FULL",
    "countries": [
    "patterns": [
    "phone_types": [
    "is_default": true,
    "is_verified": true,
    "is_active": true,
    "sort": 1,
    "created_at": "2017-11-30T11:09:28.000Z"

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.