PATCH
/
{version}
/
messages
/
{message}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

version
enum<string>
default:
v2
required

The API version to use.

Available options:
v1,
v2
message
integer
required

Query Parameters

include
enum<string>
Available options:
schedule

Body

application/json
channels
enum<string>[]
required
Available options:
broadcast,
database,
discord_private,
discord_public,
mail,
sms
message
string
required

Supports HTML.

recipients
integer[]

An array of User IDs. Defaults to everyone if no recipients are provided.

repeats
boolean
default:
false
send_at
string | null

Set a future date to send the msssage at.

sent_at
string | null

Response

200 - application/json
data
object