Update Twilio SMS Provider

Change the configuration of an SMS provider of the type Twilio. A provider has to be activated to be able to send notifications.

Path Parameters

• id string required

application/json

Request Body required

• sid string required

  Possible values: non-empty and <= 200 characters

• senderNumber string required

  Possible values: non-empty and <= 200 characters

application/grpc

Request Body required

• sid string required

  Possible values: non-empty and <= 200 characters

• senderNumber string required

  Possible values: non-empty and <= 200 characters

application/grpc-web+proto

Request Body required

• sid string required

  Possible values: non-empty and <= 200 characters

• senderNumber string required

  Possible values: non-empty and <= 200 characters

Responses

• 200
• 403
• 404
• default

---

A successful response.

application/json

• Schema
• Example (from schema)

---

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

{
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-12",
    "changeDate": "2023-05-12",
    "resourceOwner": "69629023906488334"
  }
}

application/grpc

• Schema
• Example (from schema)

---

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

{
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-12",
    "changeDate": "2023-05-12",
    "resourceOwner": "69629023906488334"
  }
}

application/grpc-web+proto

• Schema
• Example (from schema)

---

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

{
  "details": {
    "sequence": "2",
    "creationDate": "2023-05-12",
    "changeDate": "2023-05-12",
    "resourceOwner": "69629023906488334"
  }
}

Returned when the user does not have permission to access the resource.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Returned when the resource does not exist.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

An unexpected error response.

application/json

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

application/grpc-web+proto

• Schema
• Example (from schema)

---

Schema

• code int32
• message string
• details object[]

  Array [

  @type string

  ]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

PUT /sms/twilio/:id

Authorization

type: oauth2flow: authorizationCodescopes: openid,urn:zitadel:iam:org:project:id:zitadel:aud

Request

Base URL

https://$ZITADEL_DOMAIN/admin/v1

Bearer Token

id — path required

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

Body required

{
  "sid": "AB123b9e61d238abae7d3be7b65ecbc987",
  "senderNumber": "AB123b9e61d238abae7d3be7b65ecbc987"
}

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl -L -X PUT 'https://$ZITADEL_DOMAIN/admin/v1/sms/twilio/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "sid": "AB123b9e61d238abae7d3be7b65ecbc987",
  "senderNumber": "AB123b9e61d238abae7d3be7b65ecbc987"
}'

curl -L -X PUT 'https://$ZITADEL_DOMAIN/admin/v1/sms/twilio/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "sid": "AB123b9e61d238abae7d3be7b65ecbc987",
  "senderNumber": "AB123b9e61d238abae7d3be7b65ecbc987"
}'

curl -L -X PUT 'https://$ZITADEL_DOMAIN/admin/v1/sms/twilio/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "sid": "AB123b9e61d238abae7d3be7b65ecbc987",
  "senderNumber": "AB123b9e61d238abae7d3be7b65ecbc987"
}'

curl -L -X PUT 'https://$ZITADEL_DOMAIN/admin/v1/sms/twilio/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "sid": "AB123b9e61d238abae7d3be7b65ecbc987",
  "senderNumber": "AB123b9e61d238abae7d3be7b65ecbc987"
}'

curl -L -X PUT 'https://$ZITADEL_DOMAIN/admin/v1/sms/twilio/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "sid": "AB123b9e61d238abae7d3be7b65ecbc987",
  "senderNumber": "AB123b9e61d238abae7d3be7b65ecbc987"
}'

curl -L -X PUT 'https://$ZITADEL_DOMAIN/admin/v1/sms/twilio/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "sid": "AB123b9e61d238abae7d3be7b65ecbc987",
  "senderNumber": "AB123b9e61d238abae7d3be7b65ecbc987"
}'

curl -L -X PUT 'https://$ZITADEL_DOMAIN/admin/v1/sms/twilio/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "sid": "AB123b9e61d238abae7d3be7b65ecbc987",
  "senderNumber": "AB123b9e61d238abae7d3be7b65ecbc987"
}'