Skip to main content
POST
sms.group.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
autoUpdate
object

Optional automatic membership updates from people’s incoming text messages.

name
string

Your name for this group, up to 80 characters.

Required string length: 1 - 80
members
string[]

Unique phone numbers of people in this group, up to 10000.

Maximum array length: 10000

Phone number in E.164 format, including the leading plus.

Pattern: ^\+[1-9]\d{1,14}$

Response

The result

size
integer
required

Number of people in the group.

Required range: 0 <= x <= 9007199254740991
autoUpdate
object

Optional automatic membership updates from people’s incoming text messages.

name
string

Your name for this group, up to 80 characters.

Required string length: 1 - 80
createdAt
string<date-time>

Time in ISO 8601 format.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
modifiedAt
string<date-time>

Time in ISO 8601 format.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
ref
string

Reference to what this call created. Pass it as ref to sms.group.get, sms.group.update, sms.group.delete, sms.group-members.list.