Get the status of recent email notifications sent from Elevate

get/email-status
SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
createdDateTime
required
string (DateTimeFilterParam)

Filter by email notifications created before or after this timestamp

Example: createdDateTime=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
updatedDateTime
string (DateTimeFilterParam)

Filter by email notification status updated before or after this timestamp

Example: updatedDateTime=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
billRunType
string (BillRunType)

Filter by bill run type

Enum: "NORMAL" "ADHOC"
billRunId
string (IdFilterParam)

Filter by bill run identifier

Example: billRunId=0
status
string (NotificationStatus)

Filter by email notification status

Enum: "SENT" "DELIVERED" "BOUNCED" "COMPLAINT" "ERROR" "ACKNOWLEDGED" "RETRY"
bounceType
string (BounceType)

Filter by email bounce type (also filters to BOUNCED email notification status)

Enum: "PERMANENT" "TRANSIENT"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "id": 1,
    • "recipientEmail": "string",
    • "createdDateTime": "2019-08-24T14:15:22Z",
    • "updatedDateTime": "2019-08-24T14:15:22Z",
    • "status": "SENT",
    • "message": "failed, 5.3.0, smtp; 550 RCPT TO:<xxxxxx@imperatives.co.uk> User unknown",
    • "bounceType": "PERMANENT",
    • "billRunType": "NORMAL",
    • "billRunId": 1,
    • "customerId": 1,
    • "siteId": 1,
    • "contactId": 1
    }
]