Notifications

POST /send_mail

Changed on

Create and send an email message to the consumer

Request

  • Base URL
    https://api.paynearme-sandbox.com/json-api
  • Auth
    • OAuth 2
      Client credentials
      Token URLhttps://login.paynearme.com/oauth/token
    • or API key in query parameter signature

Request body

site_identifierstring required

Identifies your client site.

timestampstring required

The Unix Epoch time of the call

versionstring required

The version of the API. This version must match the version associated with your API key pair.

signaturestring

The HMAC signature that is calculated by running your API Secret Key and the alphabetized, concatenated parameters of the request payload through the SHA256 message digest algorithm.

NOTE: This field is required when authenticating with the HMAC signature method; it is not required when authenticating with OAuth 2.0.

recipientsstring required

The email addresses where you are sending the email. Use commas to separate email addresses when sending the message to multiple recipients.

subjectstring required

The subject of the email message.

body_textstring required

The text of the email message. This parameter does not support HTML or special characters like emojis.

Response

Email Sent

statusstring

Provides the status of the request.

Example response

{
  "status": "ok"
}

Changes

    • breaking

      removed the success response with the status

    • info

      api operation id send_mail was added

    • info

      the request property signature became optional

    2 more changes in this revision