Skip to content

SmsUpdateProvider

PUT sms/provider

Updates a provider in the catalogue. Only the fields present in the request are changed.

Disabling a provider stops new messages through every profile of that provider; messages already queued keep their profile and are still reported on.

Access Control

Allowed role: provider.

Request

PUT https://{broker_domain}/sms/provider
{
  "id": 1,
  "status": "DISABLED"
}
{
  "command": "SmsUpdateProvider",
  "extID": "1",
  "data": {
    "id": 1,
    "status": "DISABLED"
  }
}
const res = await platform.SmsUpdateProvider({
  id: 1,
  status: "DISABLED"
});

Request Data

Field Type Required Description
id int Yes Provider id
name string No Adapter name, lowercase without spaces
description string No Provider description
icon string | file No Icon hash or an uploaded file
url string No Provider site or panel link
options object No Credential field description for the UI
status enum No ENABLED or DISABLED
supportedUpdateModes array No NONE, REQUEST, WEBHOOK

Response Data

{
  "id": 1,
  "name": "twilio",
  "status": "DISABLED",
  "options": { "accountSid": "string", "authToken": "string" },
  "supportedUpdateModes": ["REQUEST", "WEBHOOK"],
  "adapterImplemented": true,
  "updatedAt": "2026-08-24 14:05:31"
}

Errors

Code Error Description
400 UPDATE_MODE_NOT_SUPPORTED The adapter cannot do a declared mode
404 NOT_FOUND Provider not found
409 PROVIDER_EXISTS The new name is taken by another provider