POST notification/send-email

Send an e-mail notification

Request Information

Headers

HTTP_AUTHORIZATION: Required. OAuth 1.0 parameters with the OAuth signature of the url you are going to request. The consumer keys and access token can be obtained from the community administration.

Sample:

        HTTP_AUTHORIZATION:
            OAuth oauth_token="CObXqjfOisVh9%2F2GjC7NNd8BCzY%3D",
            oauth_consumer_key="clGACsiGaMp%2FD%2BUwkSvRBxA1k50%3D",
            oauth_nonce="VqKza6d5x1HpPQWFe08spbdOnkTQpfaLfD9Oeuyg",
            oauth_signature_method="HMAC-SHA1",
            oauth_timestamp="1462882011",
            oauth_signature="RH5aKKKJaEvK5cIsZZzXtFh7cCk%3D"

Body Parameters

Name	Description	Type	Additional information
subject	Subject of the email	string	Required
message	Message of the email	string	Required
is_html	True if the message contains html	boolean	Optional
receivers	List of email receivers	Collection of string	Required
sender_mask	Sender mask	string	Optional
community_short_name	Community short name	string	Optional
transmitter_mail_configuration	Transmitter smtp config defined	MailConfigurationModel	Optional

Request Formats

application/json, text/json

Sample:

{
  "subject": "Developer's newsletter",
  "message": "<h1>This is our first newsletter!!!</h1>",
  "is_html": true,
  "receivers": [
    "you@organization.com",
    "yourpartner@organization.com"
  ],
  "sender_mask": "Developers community"
}

Response Information

Resource Description

Description	Type
	Int32

Response Formats

application/json, text/json

Sample:

Response HTTP status code

On success, the response contains 200 code.

On fail, throws a WebException with code:

401 Unauthorized if the OAuth signature is invalid
400 Bad Request if the params are invalid
500 Internal server error if something goes wrong...