Skip to main content
POST
Send email to recipient lists to specific recipients

Description

Send the campaign to the recipients depending on the recipientsType and channels passed in request body.

Validations

  • 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.
  • recipientsType: Recipient type can be ALL, UNANSWERED and ANSWERED. If ALL or no type param is passed then it will count every recipient. If ANSWERED is passed as type then it will count every recipient that has already answered the survey. If UNANSWERED it will count every recipient that hasn’t already answered the survey.

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