POST v1/admin/send/email
ADMIN - Send email
Request Information
URI Parameters
None.
Body Parameters
SendEmailRequestModelName | Description | Type | Additional information |
---|---|---|---|
email_address_list | Collection of string |
Required |
|
subject | string |
Required |
|
body | string |
Required |
|
user_company_id |
Company UID of the active user |
string |
Required Data type: Text |
user_id |
User ID (GUID) |
string |
Required Data type: Text |
user_signature |
MD5 hash signature for the active user to validate the request |
string |
Required Data type: Text |
Request Format
application/json, text/json
Sample:
{ "email_address_list": [ "sample string 1", "sample string 2" ], "subject": "sample string 1", "body": "sample string 2", "user_company_id": "sample string 3", "user_id": "sample string 4", "user_signature": "sample string 5" }
Response Information
Resource Description
ADMIN - Send email
BaseMetaResultModelName | Description | Type | Additional information |
---|---|---|---|
meta |
Basic meta information for the operation result |
MetaModel |
None. |
Response Format
application/json, text/json
Sample:
{ "meta": { "status_code": 1, "status_message": "sample string 2" } }