Services

Create Entitlement Coupons by Identity or WalletId

Changed on

This API method allows the calling application to create one or many Entitlement Account (of type COUPON) and link it to existing Subscription Account by identity value or wallet id. Either identity-value or walletId must be provided in query parameters. This API is considered a bulk action API so the user should consider performance implications of calling this API.

post/services/wallet/campaign/accounts/related

Request

  • Base URL
    https://wallet.uk.eagleeye.com/2.0
  • URL
    https://wallet.uk.eagleeye.com/2.0/services/wallet/campaign/accounts/related
  • Auth
    API key in header X-EES-AUTH-CLIENT-ID and API key in header X-EES-AUTH-HASH

Query parameters

identity-valuestring string

Wallet Identity Value

walletIdstring string

EES AIR Wallet ID

Request body

status'ACTIVE' | 'BLOCKED' | 'CANCELLED' | 'DELETED' | 'EXPIRED' | 'INACTIVE' | 'INVALIDATED' | 'LOCKED' | 'STOLEN' | 'USED' | 'SUSPENDED'

Account Status

statestring

Account state

currencystring

Example request

[
  {
    "status": "ACTIVE",
    "parentAccountId": "1",
    "campaignReference": "TEST"
  },
  {
    "status": "ACTIVE",
    "parentAccountId": "2",
    "campaignId": "1"
  }
]

Response

The request was successful and a number of related accounts created

Example response

{
  "successful": {
    "results": [
      {
        "dates": {
          "start": "2017-01-17T13:20:48+00:00",
          "end": "2017-01-17T13:20:48+00:00"
        },
        "relationships": {
          "ENTITLEMENT": {
            "accountType": [
              {
                "dateCreated": "2017-01-17T13:20:48+00:00"
              }
            ]
          },
          "ENTITLEMENT_OF": {
            "accountType": [
              {
                "dateCreated": "2017-01-17T13:20:48+00:00"
              }
            ]
          },
          "OBJECTIVE": {
            "accountType": [
              {
                "dateCreated": "2017-01-17T13:20:48+00:00"
              }
            ]
          },
          "OBJECTIVE_OF": {
            "accountType": [
              {
                "dateCreated": "2017-01-17T13:20:48+00:00"
              }
            ]
          },
          "PROMOTION": {
            "accountType": [
              {
                "dateCreated": "2017-01-17T13:20:48+00:00"
              }
            ]
          },
          "PROMOTION_OF": {
            "accountType": [
              {
                "dateCreated": "2017-01-17T13:20:48+00:00"
              }
            ]
          },
          "BOUNCE_BACK_REWARD": {
            "accountType": [
              {
                "dateCreated": "2017-01-17T13:20:48+00:00"
              }
            ]
          },
          "BOUNCE_BACK_REWARD_OF": {
            "accountType": [
              {
                "dateCreated": "2017-01-17T13:20:48+00:00"
              }
            ]
          },
          "COUPON_STAMP_REWARD": {
            "accountType": [
              {
                "dateCreated": "2017-01-17T13:20:48+00:00"
              }
            ]
          },
          "COUPON_STAMP_REWARD_OF": {
            "accountType": [
              {
                "dateCreated": "2017-01-17T13:20:48+00:00"
              }
            ]
          },
          "LOYALTY_POINTS_REWARD_OF": {
            "accountType": [
              {
                "dateCreated": "2017-01-17T13:20:48+00:00"
              }
            ]
          }
        },
        "dateCreated": "2017-01-17T13:20:48+00:00",
        "lastUpdated": "2017-01-17T13:20:48+00:00"
      }
    ]
  }
}

Changes

    • breaking

      removed from the ///////////// request property oneOf list

    • breaking

      added the pattern /\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/ to the request property //////////////

    • breaking

      added the pattern /\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/ to the request property //////////////

    • breaking

      the ///////////// request property type changed from no type to object

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response's body type changed from no type to object for status

    • breaking

      the response property /////// became optional for the status

    • breaking

      the response property /////// became optional for the status

    • breaking

      the /////// response's property format changed from date-time to no format for status

    • breaking

      the /////// response's property format changed from date-time to no format for status

    • breaking

      the //////// response's property format changed from date-time to no format for status

    • breaking

      the //////// response's property format changed from date-time to no format for status

    • breaking

      the //////// response's property format changed from date-time to no format for status

    • breaking

      the //////// response's property format changed from date-time to no format for status

    • breaking

      the /////// response's property format changed from date-time to no format for status

    • breaking

      the /////// response's property format changed from date-time to no format for status

    • breaking

      the ///////// response's property type changed from object to array for status

    • breaking

      the ///////// response's property type changed from object to array for status

    • breaking

      the ///////// response's property type changed from object to array for status

    • breaking

      the ///////// response's property type changed from object to array for status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • breaking

      removed the required property ////////// from the response with the status

    • warning

      removed the request property //////////////

    • warning

      removed the request property //////////////

    • warning

      removed the optional property /////// from the response with the status

    • warning

      removed the optional property /////// from the response with the status

    • warning

      added the new AALR enum value to the //// response property for the response status

    • warning

      added the new AALR enum value to the //// response property for the response status

    • warning

      added the new AALR enum value to the //// response property for the response status

    • warning

      added the new AALR enum value to the //// response property for the response status

    • warning

      added the new AALR enum value to the /////// response property for the response status

    • warning

      added the new AALR enum value to the /////// response property for the response status

    • warning

      added the new CILR enum value to the //// response property for the response status

    • warning

      added the new CILR enum value to the //// response property for the response status

    • warning

      added the new CILR enum value to the //// response property for the response status

    • warning

      added the new CILR enum value to the //// response property for the response status

    • warning

      added the new CILR enum value to the /////// response property for the response status

    • warning

      added the new CILR enum value to the /////// response property for the response status

    • warning

      added the new CLPPR enum value to the //// response property for the response status

    • warning

      added the new CLPPR enum value to the //// response property for the response status

    • warning

      added the new CLPPR enum value to the //// response property for the response status

    • warning

      added the new CLPPR enum value to the //// response property for the response status

    • warning

      added the new CLPPR enum value to the /////// response property for the response status

    • warning

      added the new CLPPR enum value to the /////// response property for the response status

    • warning

      added the new CONTINUITY enum value to the /////// response property for the response status

    • warning

      added the new CONTINUITY enum value to the /////// response property for the response status

    • warning

      added the new ELE enum value to the //// response property for the response status

    • warning

      added the new ELE enum value to the //// response property for the response status

    • warning

      added the new ELE enum value to the //// response property for the response status

    • warning

      added the new ELE enum value to the //// response property for the response status

    • warning

      added the new ELE enum value to the /////// response property for the response status

    • warning

      added the new ELE enum value to the /////// response property for the response status

    • warning

      added the new POINTS enum value to the /////// response property for the response status

    • warning

      added the new POINTS enum value to the /////// response property for the response status

    • warning

      added the new QUEST enum value to the /////// response property for the response status

    • warning

      added the new QUEST enum value to the /////// response property for the response status

    • warning

      added the new RF enum value to the //// response property for the response status

    • warning

      added the new RF enum value to the //// response property for the response status

    • warning

      added the new RF enum value to the //// response property for the response status

    • warning

      added the new RF enum value to the //// response property for the response status

    • warning

      added the new RF enum value to the /////// response property for the response status

    • warning

      added the new RF enum value to the /////// response property for the response status

    • warning

      added the new RFL enum value to the //// response property for the response status

    • warning

      added the new RFL enum value to the //// response property for the response status

    • warning

      added the new RFL enum value to the //// response property for the response status

    • warning

      added the new RFL enum value to the //// response property for the response status

    • warning

      added the new RFL enum value to the /////// response property for the response status

    • warning

      added the new RFL enum value to the /////// response property for the response status

    • warning

      added the new STAMP_CARD enum value to the /////// response property for the response status

    • warning

      added the new STAMP_CARD enum value to the /////// response property for the response status

    • warning

      added the new STANDARD_SUBSCRIPTION enum value to the /////// response property for the response status

    • warning

      added the new STANDARD_SUBSCRIPTION enum value to the /////// response property for the response status

    • warning

      added the new SUSPENDED enum value to the /////// response property for the response status

    • warning

      added the new SUSPENDED enum value to the /////// response property for the response status

    • warning

      added the new TBR enum value to the //// response property for the response status

    • warning

      added the new TBR enum value to the //// response property for the response status

    • warning

      added the new TBR enum value to the //// response property for the response status

    • warning

      added the new TBR enum value to the //// response property for the response status

    • warning

      added the new TBR enum value to the /////// response property for the response status

    • warning

      added the new TBR enum value to the /////// response property for the response status

    • warning

      added the new TBS enum value to the //// response property for the response status

    • warning

      added the new TBS enum value to the //// response property for the response status

    • warning

      added the new TBS enum value to the //// response property for the response status

    • warning

      added the new TBS enum value to the //// response property for the response status

    • warning

      added the new TBS enum value to the /////// response property for the response status

    • warning

      added the new TBS enum value to the /////// response property for the response status

    • warning

      added the new WLNF enum value to the //// response property for the response status

    • warning

      added the new WLNF enum value to the //// response property for the response status

    • warning

      added the new WLNF enum value to the //// response property for the response status

    • warning

      added the new WLNF enum value to the //// response property for the response status

    • warning

      added the new WLNF enum value to the /////// response property for the response status

    • warning

      added the new WLNF enum value to the /////// response property for the response status

    • warning

      added the new WTF enum value to the //// response property for the response status

    • warning

      added the new WTF enum value to the //// response property for the response status

    • warning

      added the new WTF enum value to the //// response property for the response status

    • warning

      added the new WTF enum value to the //// response property for the response status

    • warning

      added the new WTF enum value to the /////// response property for the response status

    • warning

      added the new WTF enum value to the /////// response property for the response status

    • warning

      added the new WTNF enum value to the //// response property for the response status

    • warning

      added the new WTNF enum value to the //// response property for the response status

    • warning

      added the new WTNF enum value to the //// response property for the response status

    • warning

      added the new WTNF enum value to the //// response property for the response status

    • warning

      added the new WTNF enum value to the /////// response property for the response status

    • warning

      added the new WTNF enum value to the /////// response property for the response status

    • info

      added the new optional request property //////////////

    • info

      added the new optional request property //////////////

    • info

      added the new optional request property //////////////

    • info

      added the new optional request property //////////////

    • info

      added the new optional request property //////////////

    • info

      added the new optional request property //////////////

    • info

      added the new optional request property //////////////

    • info

      added the new optional request property //////////////

    • info

      the ////////////// request property format was generalized from date-time to no format

    • info

      the ////////////// request property format was generalized from date-time to no format

    • info

      added to the response body allOf list for the response status

    • info

      added to the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status

    • info

      removed from the response body allOf list for the response status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property //// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response's property default value ACTIVE was added for the status

    • info

      the response's property default value ACTIVE was added for the status

    • info

      the /////// response's property pattern /\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/ was added for the status

    • info

      the /////// response's property pattern /\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/ was added for the status

    • info

      the //////// response's property pattern /\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/ was added for the status

    • info

      the //////// response's property pattern /\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/ was added for the status

    • info

      the //////// response's property pattern /\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/ was added for the status

    • info

      the //////// response's property pattern /\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/ was added for the status

    • info

      the /////// response's property pattern /\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/ was added for the status

    • info

      the /////// response's property pattern /\d{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2]\d|3[0-1])T[0-2]\d:[0-5]\d:[0-5]\d[+-][0-2]\d:[0-5]\d/ was added for the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property /////// to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    This list may be incomplete.