Skip to main content

Add Twilio SMS Provider​

Configure a new SMS provider of the type Twilio. A provider has to be activated to be able to send notifications.

Request Body required
    sid string required

    Possible values: non-empty and <= 200 characters

    token string required

    Possible values: non-empty and <= 200 characters

    senderNumber string required

    Possible values: non-empty and <= 200 characters

Responses

A successful response.

Schema
    details object
    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

    resourceOwner resource_owner is the organization an object belongs to
    id string
POST /sms/twilio

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid",
      "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud"
    }
  }
}

Request

Base URL
https://$CUSTOM-DOMAIN/admin/v1
Bearer Token
Content-Type
Body required
{

  "sid": "AB123b9e61d238abae7d3be7b65ecbc987",

  "token": "string",

  "senderNumber": "AB123b9e61d238abae7d3be7b65ecbc987"

}
Accept
curl / cURL
curl -L -X POST 'https://$CUSTOM-DOMAIN/admin/v1/sms/twilio' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "sid": "AB123b9e61d238abae7d3be7b65ecbc987",
  "token": "string",
  "senderNumber": "AB123b9e61d238abae7d3be7b65ecbc987"
}'