v1

latestOpenAPI 3.0.12026-07-243266138.0 KB

Endpoints

Get a list of invites

This method retrieves the list of review invites by channel ID. The result set can be modified using a set of filters.

The path must contain a channelId. Note that this must be the channel ID that was assigned by eTrusted and not a user-defined ID.

Query parameters can be added to the request, separated by &. By adding parameters to the request, you can filter the result list and:

specify the maximum number of invites they want to retrieve with this request
retrieve invites submitted within a certain time frame

The response object contains the list of invite objects as well as information for paginating invites in a user interface. See our guide on paginating response data for more information.

get/channels/{id}/invites

Path parameters

idstring required

The channel UUID for which to retrieve the list of invites.

Query parameters

countinteger

The desired number of invite objects to be retrieved per page.

afterstring

after is an invite UUID. The list of invites in the response will only contain invites sent earlier than the invite with this ID.

beforestring

before is an invite UUID. The list of invites in the response will only contain invites sent later than the invite with this ID.

querystring

query is a search term that is matched against the transaction reference and customer email address properties (see the response schema). Only matching invites will be included in the response.

Headers

tokenstring required

An authorisation header containing meta information, see OAuth2.

Channel-Idstring

Channel-Id contains the user-defined channel name. This allows the resource to to be called without a channel ID in the path. If using this header, the channel ID in the path must be set to "user-defined".

Response

The list of invites.

totalElementsinteger

This field has the default value of 0 and will be removed in the future cause backend compatibillity issue.

Example response

{
  "totalElements": 95,
  "paging": {
    "count": 10,
    "cursor": {
      "after": "inv-xxxxxxxb-yyyy-xxxx-yyyy-xxxxxxxxxxxx",
      "before": "inv-xxxxxxxa-yyyy-xxxx-yyyy-xxxxxxxxxxxx"
    },
    "links": {
      "previous": "https://api.etrusted.com/channels/channelId/invites?count=10&before=inv-xxxxxxxa-yyyy-xxxx-yyyy-xxxxxxxxxxxx",
      "next": "https://api.etrusted.com/channels/channelId/invites?count=10&after=inv-xxxxxxxb-yyyy-xxxx-yyyy-xxxxxxxxxxxx"
    }
  },
  "items": [
    {
      "id": "inv-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx",
      "_object": "Invite",
      "mode": "AUTOMATIC",
      "reviewType": "SERVICE_REVIEW",
      "accountRef": "acc-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx",
      "channelRef": "chl-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx",
      "locale": "en_GB",
      "platform": "GOOGLE",
      "customer": {
        "id": "cst-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx",
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@example.com",
        "phoneNumber": "442071838750",
        "preferredLocale": "en_GB",
        "consents": [
          {
            "purpose": "DATA_FORWARDING"
          }
        ]
      },
      "inviteSource": "TRUSTBADGE",
      "transaction": {
        "id": "txn-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx",
        "reference": "ORDER-12792",
        "date": "2018-01-04T12:09:50.722Z"
      },
      "scheduledAt": "2018-01-04T12:09:50.722Z",
      "estimatedDeliveryDate": "2017-01-07",
      "template": {
        "id": "qrt-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx",
        "name": "After Sales Standard EN"
      },
      "sender": {
        "name": "eTrusted",
        "email": "ex@mple.com"
      },
      "replyTo": {
        "name": "eTrusted",
        "email": "ex@mple.com"
      },
      "event": "evt-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx",
      "createdAt": "2018-02-01T17:09:41.79Z",
      "updatedAt": "2018-02-01T17:09:41.79Z",
      "sentAt": "2018-02-01T17:09:41.79Z",
      "status": {
        "name": "REJECTED",
        "reason": "INVALID_RECIPIENT_EMAIL"
      }
    }
  ]
}