Sends a transactional mailing to the Contact

post

/services/rest/connect/v1.4/contacts/{id}/sendMailing

Request

Path Parameters
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : chat
Type: object
The chat that will be used to trigger the mailing
Nested Schema : incident
Type: object
The incident that will be used to trigger the transactional mailing
Nested Schema : mailing
Type: object
The mailing to send
Show Source
Nested Schema : opportunity
Type: object
The opportunity that will be used to trigger the transactional mailing

Response

Default Response

Examples

You can send transactional mailing to a contact at a scheduled time using the REST API. Use POST with the following syntax to send a mailing:

https://your_site_interface/services/rest/connect/version/contacts/contact_id/sendMailing

The request has the parameters shown in the following table.

Parameter Description
mailing Required. ID of the mailing.
incident or opportunity Incident or opportunity ID. You cannot use both.
scheduledTime Time when the mailing will be sent, in ISO-8601 format. If scheduledTime is not specified, the mailing will be sent immediately.

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/contacts/1/sendMailing

Request body example

{
"mailing": {id": 123},
"incident": {"id": 12},
"scheduledTime": "2016-02-28T04:00:00Z"
}

Response example

The status 200 OK is returned, indicating that the mailing has been scheduled.