Skip to main content
POST
Add an SMS sender rule

Authorizations

Authorization
string
header
required

Agent token (alt_…) or OAuth access token; bound to one agent

Path Parameters

phoneNumberId
string
required

Phone number id

Body

application/json
kind
enum<string>
required
Available options:
allow,
block
pattern
string
required

Full number like +14155552671 or a prefix like +1415* or +49*

Required string length: 3 - 20
note
string
Maximum string length: 200

Response

Rule

id
string
required
phone_number_id
string
required
kind
enum<string>
required
Available options:
allow,
block
pattern
string
required
note
string | null
required
created_at
string<date-time>
required