Config

Retrieve a Email

Work with email.Retrieves the Email with the given ID.

get/admin/config/mail/{id}

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/config/mail/{id}
  • Auth: HTTP basic

Path parameters

idnumber double required
Example:1

The ID of the desired Email.

Response

typestring required

Email type: 'message', 'test', 'monitoring', 'add-on', 'ticket'.

subjectstring required

Email subject.

message_idnumber

Message ID.

bccstring

BCC Email copy.

ccstring

CC Email copy.

customer_idnumber

Customer ID.

fromstring

Email address used at the time of sending.

statusstring

Email status: 'new', 'sending', 'sent', 'error', 'expired'. Default value 'new'.

prioritynumber

Email priority: 1 - Low, 2 - Medium, 3 - High. Default: 2

datetime_addedstring

Added datetime. Format: 'YYYY-MM-DD HH:MM:SS'.

datetime_start_sendingstring

Sending datetime. Format: 'YYYY-MM-DD HH:MM:SS'.

datetime_sentstring

Sent datetime. Format: 'YYYY-MM-DD HH:MM:SS'.

recipientstring required

Recipient email.

messagestring required

Email message.

sendCopyboolean

Send copy this mail to email from config

admin_idnumber

Admin ID.

notification_category'billing_and_payments' | 'service_and_support' | 'promotions_and_offers' | 'sub_accounts' | 'account_and_security' | 'administrative_notification' nullable

Customer notification

idnumber required

Email ID

Example response

{
  "notification_category": "promotions_and_offers",
  "type": "message",
  "subject": "Reminder 1",
  "message_id": 50,
  "bcc": "template@mail.box,template2@mail.box",
  "cc": "template@mail.box,template2@mail.box",
  "customer_id": 1,
  "from": "info@splynx.com",
  "status": "sent",
  "priority": 2,
  "datetime_added": "2017-01-01 00:00:00",
  "datetime_start_sending": "2017-01-01 00:00:00",
  "datetime_sent": "2017-01-01 00:00:00",
  "recipient": "recipient@splynx.com",
  "message": "Email message",
  "sendCopy": true,
  "admin_id": 1,
  "id": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.