Skip to main content

Add HTTP SMS Provider

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

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

Request​

Body

required

    endpoint stringrequired

    Possible values: non-empty and <= 2048 characters

    description string

    Possible values: <= 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 (string)
    id string
curl -L 'https://$CUSTOM-DOMAIN/admin/v1/sms/http' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "endpoint": "http://relay.example.com/provider",
  "description": "provider description"
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/admin/v1
Auth
Body required
{
  "endpoint": "http://relay.example.com/provider",
  "description": "provider description"
}
ResponseClear

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