Help Contents

 

User Mail

Resource: User Mail ( /api/user/{userId}/mailmessages )

Allows the queuing for delivery of a mail message to a user

This resource supports the following methods: POST

Methods

POST


Enqueues a mail message for delivery to the user.

Required Permissions

  • Administration/Organisation

Status Codes

These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
201 - CreatedReturned if the message was enqueued successfully.
403 - ForbiddenReturned if the user does not have permission to send a mail message to the target user.

Example - Queue a mail message to be sent

Enqueue a mail message to be delivered to a user.

Request Headers

KeyValueDescription
Acceptapplication/json

Request Parameters

KeyValueDescription
{userId}A8983284-D2A7-4684-9C37-1BD565E96FFFThe unique identifier of the user to send a message

Request Body

{
  "Subject": "Shutdown",
  "Body": "The Enterprise Tester server will be shutting down for maintenance in 30 minutes"
}

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Status Code

201 - Created