Skip to main content
POST
Create SMS gateway

Authorizations

Authorization
string
header
required

Use a valid Bearer token to authenticate.

Body

application/json
label
string
required

Name for this gateway. Example: Main SMS provider

Maximum string length: 200
endpoint
string
required

Provider URL. May contain {recipient} and {message}. Example: https://sms.example.com/api/send

Maximum string length: 2000
httpMethod
enum<string>
required

HTTP method used to call the provider. Example: POST

Available options:
POST,
GET
bodyParams
object[]
required

Body parameters (query parameters for GET).

testRecipient
string
required

Phone number that receives the verification SMS, international format with 7-15 digits. Example: +6281234567890

headers
object[]

Request headers.

successMatch
object

Optional check on the provider response. Example: {"jsonPath": "status", "equals": "queued"}

isActive
boolean

Whether the gateway is used for sending. Defaults to true on create.

Response

Success

status
boolean

Status of response.

data
object

Saved SMS gateway.