Skip to content
email-status/
Get the status of recent...

Elevate Notifications API (1.0)

Elevate notifications

Provides read-only access to the current status of email notifications sent from Elevate. NOTE: this service is only effective if using Amazon SES distribution

Definitions

  • Email Status - status of email notification sent e.g. invoice email and whether it failed due to a bounce from the email distribution service
Download OpenAPI description
billing-rest-notifications.json
billing-rest-notifications.yaml
Languages
Servers
https://rest.elevatebilling.com/v1

email-status

Status of email notifications sent from Elevate with delivery details as provided by the email distribution service

Operations

Get the status of recent email notifications sent from Elevate

Request

Security
bearerAuth
Query
pageinteger(int32)(PageParam)>= 1required

Page of results to show

Example: page=1
pageSizeinteger(int32)(ResultsPerPageParam)[ 1 .. 1000 ]required

Results to return per page

Example: pageSize=100
sortstring(SortParam)

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

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

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

Example: fields=id,name
createdDateTimestring(DateTimeFilterParam)required

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
updatedDateTimestring(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
billRunTypestring(BillRunType)

Filter by bill run type

Enum"NORMAL""ADHOC"
billRunIdstring(IdFilterParam)

Filter by bill run identifier

Example: billRunId=0
statusstring(NotificationStatus)

Filter by email notification status

Enum"SENT""DELIVERED""BOUNCED""COMPLAINT""ERROR""ACKNOWLEDGED""RETRY"
bounceTypestring(BounceType)

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

Enum"PERMANENT""TRANSIENT"
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/email-status?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&createdDateTime=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&updatedDateTime=yyyy-MM-ddTHH%3Amm%3AssZ+%2C+lt%3Ayyyy-MM-ddTHH%3Amm%3AssZ+%2C+gt%3Ayyyy-MM-ddTHH%3Amm%3AssZ&billRunType=NORMAL&billRunId=0&status=SENT&bounceType=PERMANENT' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Email notification status identifier

Example: 1
recipientEmailstring

Recipient email address

createdDateTimestring(date-time)read-only

Email notification created time

updatedDateTimestring(date-time)read-only

Email notification status last updated time

statusstring(NotificationStatus)

Status of email notification

Enum"SENT""DELIVERED""BOUNCED""COMPLAINT""ERROR""ACKNOWLEDGED""RETRY"
messagestring

Status message including any reason for email bounce or complaint

Example: "failed, 5.3.0, smtp; 550 RCPT TO:<xxxxxx@imperatives.co.uk> User unknown"
bounceTypestring(BounceType)

Bounce type

Enum"PERMANENT""TRANSIENT"
billRunTypestring(BillRunType)

Billing run type

Enum"NORMAL""ADHOC"
billRunIdinteger(int64)

Bill run identifier that the notification was linked to

Example: 1
customerIdinteger(int64)

Customer identifier

Example: 1
siteIdinteger(int64)

Site identifier

Example: 1
contactIdinteger(int64)

Site contact identifier

Example: 1
]
Response
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
  }
]