Update Custom Provider for SMS Notifications

Updates the custom provider for SMS Notifications for a given app.

PUT /notifications/sms/v1/providers/custom

Update Custom Provider for SMS Notifications

cURL

curl --request PUT \
  --url https://{appId}.api-{region}.cometchat.io/v3/notifications/sms/v1/providers/custom \
  --header 'Content-Type: application/json' \
  --header 'apikey: <api-key>' \
  --data '
{
  "isEnabled": true,
  "useStoredPhNo": true,
  "webhookURL": "<string>",
  "useBasicAuth": true,
  "basicAuthUsername": "<string>",
  "basicAuthPassword": "<string>"
}
'

200

{
  "data": {
    "basicAuthUsername": "user889",
    "basicAuthPassword": "pass122",
    "isEnabled": true,
    "useBasicAuth": true,
    "useStoredPhNo": false,
    "webhookURL": "https://trigger-sms.example.com/cometchat"
  }
}

For the complete error reference, see Error Guide.

Authorizations

apikey · string · header · required

API Key with fullAccess scope(i.e. Rest API Key from the Dashboard).

Body

application/json

isEnabled · boolean

Use custom provider

useStoredPhNo · boolean

If enabled, the webhook will be triggered for a user only if their phone number is stored within CometChat.

webhookURL · string

The webhook URL triggered for respective events

useBasicAuth · boolean

To enable basic auth for the URL

basicAuthUsername · string

The username for Basic auth

basicAuthPassword · string

The password for Basic auth

Response

200 - application/json

Save the push notification's SMS custom provider

The response is of type object.