Get the communication preference history of a client

GET

https://api-v2.test.eldowallet.fr/clients/:clientId/communication-preferences/history

Returns the paginated history of a client's communication preference changes, newest first. Each entry gives the channel and event concerned, the old and new value, who made the change and when, with translated labels.

Request

path parameters

• clientId string required
  Client ID (24-character hexadecimal ObjectId).

query parameters

• page string required
  Page number, starting at `1`. Default: `1`.
• limit string required
  Entries per page. Default: `20`.
• lang string required
  Language of the labels (`channelLabel`, `eventLabel`, `oldValueLabel`, `newValueLabel`): `fr` or `en`. Default: `fr`.

header parameters

• x-lang string
  Language for responses
  enum: en, frdefault: "en"

Responses

200

Schema application/json

• docs object[] required
• totalDocs number required
• limit number required
• page number
• totalPages number required
• pagingCounter number required
• hasPrevPage boolean required
• hasNextPage boolean required
• prevPage number
• nextPage number

401

UNAUTHORIZED

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

403

FORBIDDEN

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

500

UNKNOWN_ERROR

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email