Registrar Web Services

<back to all web services

R_SendEmailRequest

Requires Authentication
Requires the role:Admin
The following routes are available for this service:
POST,OPTIONS/R_SendEmailRequest
R_SendEmailRequest Parameters:
NameParameterData TypeRequiredDescription
EmailbodystringNo
SubjectbodystringNo
TextbodystringNo
HtmlbodystringNo
DisplayNamebodystringNo
BrandIdbodylong?No
BaseAdminRequest Parameters:
NameParameterData TypeRequiredDescription
RequesterformstringNoIdentity of the caller
R_SendEmailResponse Parameters:
NameParameterData TypeRequiredDescription
EmailformstringNo
StatusformR_EmailResultStatusNo
RejectReasonformstringNo
IdformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /csv/reply/R_SendEmailRequest HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: text/csv
Content-Length: length

{"Email":"String","Subject":"String","Text":"String","Html":"String","DisplayName":"String","BrandId":0,"Requester":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Email":"String","Status":"Sent","RejectReason":"String","Id":"String"}