Requires the role: | Admin |
GET,OPTIONS | /R_EmailLogs | ||
---|---|---|---|
GET,OPTIONS | /R_EmailLogs/{Ids} | ||
GET,OPTIONS | /R_EmailLogs/EmailIds/{EmailIds} | ||
GET,OPTIONS | /R_EmailLogs/BrandIds/{BrandIds} | ||
GET,OPTIONS | /R_EmailLogs/ExternalIds/{ExternalIds} | ||
GET,OPTIONS | /R_EmailLogs/XDaysOfLogs/{LastNumberOfDaysOfLogs}/{ShowOnlyFailedEmails} |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Ids | path | List<long> | No | |
BrandIds | path | List<long> | No | |
EmailIds | path | List<string> | No | |
ExternalIds | path | List<string> | No | |
LastNumberOfDaysOfLogs | path | int | No | |
ShowOnlyFailedEmails | path | bool | No | |
StartIndex | query | long? | No | |
NumberOfRecords | query | long? | No | |
PartialEmailId | query | string | No | |
PartialEmailSubject | query | string | No | |
PartialEmailBody | query | string | No | |
IncludeAccountHolder | query | bool | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/R_EmailLogs HTTP/1.1
Host: regapi.pumpalarm.com
Content-Type: application/json
Content-Length: length
{"Ids":[0],"BrandIds":[0],"EmailIds":["String"],"ExternalIds":["String"],"LastNumberOfDaysOfLogs":0,"ShowOnlyFailedEmails":false,"StartIndex":0,"NumberOfRecords":0,"PartialEmailId":"String","PartialEmailSubject":"String","PartialEmailBody":"String","IncludeAccountHolder":false}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length [{"Id":0,"Reason":"String","LastEventDateTime":"\/Date(-62135596800000-0000)\/","Email":"String","CorrectedEmail":"String","EmailAddedToBlackListAt":"\/Date(-62135596800000-0000)\/","ExternalId":"String","EmailStateTypeId":0,"Subject":"String","Sender":"String","EmailTemplate":"String","BounceDescription":"String","DisplayName":"String","Text":"String","Html":"String","CreateDateTime":"\/Date(-62135596800000-0000)\/","EmailProcessed":false,"PhoneNumber":"String","FirstName":"String","LastName":"String","Address1":"String","Address2":"String","City":"String","StateProvince":"String","ZipCode":"String","Country":"String","AccountHolderId":0,"BrandId":0,"TotalCount":0,"AccountHolder":{"Id":0,"AccountId":0,"CreationDateTime":"\/Date(-62135596800000-0000)\/","Email":"String","PhoneNumber":"String","FirstName":"String","LastName":"String","Address1":"String","Address2":"String","City":"String","StateProvince":"String","ZipCode":"String","Country":"String","CreditCardNumber":"String","CardCode":"String","ExpirationMonth":0,"ExpirationYear":0,"NeedToUpdatePaymentInfo":false,"UpdatePaymentInfoDate":"\/Date(-62135596800000-0000)\/","TotalNumberOfRecords":0}}]