Add Twilio SMS Provider

POST 
https://$CUSTOM-DOMAIN/admin/v1/sms/twilio

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

Request

application/json

Body

required

sid stringrequired

Possible values: non-empty and <= 200 characters

token stringrequired

Possible values: non-empty and <= 200 characters

senderNumber string

Possible values: <= 200 characters

description string

Possible values: <= 200 characters

verifyServiceSid string

Possible values: <= 200 characters

application/grpc

Body

required

sid stringrequired

Possible values: non-empty and <= 200 characters

token stringrequired

Possible values: non-empty and <= 200 characters

senderNumber string

Possible values: <= 200 characters

description string

Possible values: <= 200 characters

verifyServiceSid string

Possible values: <= 200 characters

application/grpc-web+proto

Body

required

sid stringrequired

Possible values: non-empty and <= 200 characters

token stringrequired

Possible values: non-empty and <= 200 characters

senderNumber string

Possible values: <= 200 characters

description string

Possible values: <= 200 characters

verifyServiceSid string

Possible values: <= 200 characters

Responses

200

A successful response.

application/json

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 (string)
id string

Example (from schema)

{
  "details": {
    "sequence": "2",
    "creationDate": "2025-03-04T16:03:38.453Z",
    "changeDate": "2025-03-04T16:03:38.453Z",
    "resourceOwner": "69629023906488334"
  },
  "id": "string"
}

application/grpc

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 (string)
id string

Example (from schema)

{
  "details": {
    "sequence": "2",
    "creationDate": "2025-03-04T16:03:38.454Z",
    "changeDate": "2025-03-04T16:03:38.454Z",
    "resourceOwner": "69629023906488334"
  },
  "id": "string"
}

application/grpc-web+proto

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 (string)
id string

Example (from schema)

{
  "details": {
    "sequence": "2",
    "creationDate": "2025-03-04T16:03:38.454Z",
    "changeDate": "2025-03-04T16:03:38.454Z",
    "resourceOwner": "69629023906488334"
  },
  "id": "string"
}

403

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

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

404

Returned when the resource does not exist.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

application/grpc-web+proto

Schema

Schema

code int32
message string

details

object[]

Array [

@type string

]

Example (from schema)

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

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L 'https://$CUSTOM-DOMAIN/admin/v1/sms/twilio' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "sid": "AB123b9e61d238abae7d3be7b65ecbc987",
  "token": "string",
  "senderNumber": "AB123b9e61d238abae7d3be7b65ecbc987",
  "description": "provider description",
  "verifyServiceSid": "AB123b9e61d238abae7d3be7b65ecbc987"
}'

Request Collapse all

Base URL

https://$CUSTOM-DOMAIN/admin/v1

Auth

Bearer Token

Body required

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

{
  "sid": "AB123b9e61d238abae7d3be7b65ecbc987",
  "token": "string",
  "senderNumber": "AB123b9e61d238abae7d3be7b65ecbc987",
  "description": "provider description",
  "verifyServiceSid": "AB123b9e61d238abae7d3be7b65ecbc987"
}

ResponseClear

Click the Send API Request button above and see the response here!