Skip to main content
POST
Send email to recipient lists

Description

Send an email and/or sms to every recipient set on the campaign. It will also send a delivery notification to every member of the project.

Validations

  • If campaign is not found the response will be an error with 404 status code.
  • If there is a problem communicating with project service will return an error with 404 status code.

Response

No response with 204 status.

Body

The body for the request is an object that contains the property channels where:
  • channels: Array of strings that can contain the strings email or sms.
If only email is received only emails will be sent (Recipients without emails will be ignored). If only sms is received only sms will be sent (Recipients without sms will be ignored). If both are received sms and email will be sent to every recipient. If the recipient doesn’t have an email or a phone it will ignore the email or the sms respectively.

Authorizations

Authorization
string
header
required

Access token obtained from the m2m-token endpoint.

Headers

Authorization
string
required

Body

application/json

The body is of type object.

Response

Successful response