REST API: Messages
Last updated
Last updated
Replace {subdomain}
in the endpoints below with your Vitally subdomain.
You can find your subdomain in the URL used to log into Vitally (i.e., https://yoursubdomain.vitally.io
Participant
POST
US Data Center (default):
EU Data Center:
Request Body
Participant
Example Request
Example Response
GET
US Data Center (default):
EU Data Center:
Request Parameters
DELETE
US Data Center (default):
EU Data Center:
Request Params
Property
Type
Description
Editable
id
string
Vitally's unique ID for the Message
No
type
"inbound"
| "outbound"
The type of Message. Inferred from the sender type.
No
externalId
string
The unique ID of the message in your system
Only on create
timestamp
string
The ISO-formatted string timestamp of when the message was sent
Yes
message
string
Required The HTML content of the message.
Yes
from
Participant
Required A JSON object describing the sender Participant.
Yes
to
Participant[]
Required An array of JSON objects describing the recipient Participants.
Yes
cc
Participant[]
An array of JSON objects describing the cc recipient Participants.
Yes
bcc
Participant[]
An array of JSON objects describing the bcc recipient Participants.
Yes
Property
Type
Description
type
string
"admin"
or "user"
id
string
The unique Vitally ID of the Admin or User
Property
Type
Description
externalId
string
Required The unique ID of the message in your system
message
string
Required The HTML content of the message.
from
Participant
Required A JSON object describing the sender Participant.
to
Participant[]
Required An array of JSON objects describing the recipient Participants.
timestamp
string
The ISO-formatted string timestamp of when the message was sent
cc
Participant[]
An array of JSON objects describing the cc recipient Participants.
bcc
Participant[]
An array of JSON objects describing the bcc recipient Participants.
Property
Type
Description
type
string
"admin"
or "user"
id
string
The ID of the Admin or User
Property
Type
Description
id
string
The message ID assigned by Vitally
Property
Type
Description
id
string
The message ID assigned by Vitally