Send an email

POST {{baseUrl}}/api/emails

Send an email to specified recipients. You obtain the authorization token needed to execute the request using POST /auth/login; you pass the authorization token in the request header. In the body parameter of the request, you specify the recipients of the email, the content of the subject line, the content of the message body, whether the content is HTML, and any extra properties.

Request Params

KeyDatatypeRequiredDescription
fieldsstringComma-separated, top-level field whitelist that allows the client to selectively retrieve part of the response model. If specified, extra filtering is applied, and for top-level object (if root model is an array, each array element), only the listed fields are kept in the response. For example, "id,elements" keeps only the "id" field and whole "elements" array field, omitting all other fields in the top-level response model.

Request Body

{"notificationType"=>"DOSSIER_COMMENT", "userIds"=>["{{rd_userId}}"], "subject"=>"Practice Email", "content"=>"<html xmlns=\"http:\\www.w3.org\\1999\\xhtml\"><body align=\"center\" style=\"margin:0;padding:0;font-family:'Helvetica';font-size:14px;\"><div>Hello and welcome to the Developer Team at Big Company</div><div>TestUser</div>testuser<div></div></body></html>", "isHTML"=>true}

HEADERS

KeyDatatypeRequiredDescription
X-MSTR-AuthTokenstring(Required) Authorization token
Content-Typestring