PATCH
/
{version}
/
messages
/
{message}
curl --request PATCH \
  --url https://api.perscom.io/{version}/messages/{message} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "message": "<string>",
  "channels": [
    "broadcast"
  ],
  "recipients": [
    123
  ],
  "repeats": false,
  "send_at": "2023-11-07T05:31:56Z",
  "sent_at": "2023-11-07T05:31:56Z"
}'
{
  "data": {
    "id": 123,
    "message": "<string>",
    "channels": [
      "broadcast"
    ],
    "recipients": [
      123
    ],
    "repeats": false,
    "send_at": "2023-11-07T05:31:56Z",
    "sent_at": "2023-11-07T05:31:56Z",
    "label": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

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
​
message
string
required

Supports HTML.

​
channels
enum<string>[]
required
Available options:
broadcast,
database,
discord_private,
discord_public,
mail,
sms
​
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
OK
​
data
object

Was this page helpful?

Delete messageCreate a batch of messages