Sign in

v1

latestOpenAPI 3.0.32026-07-243003151.2 MB
Consumer

Update

This method allows the calling application to update Consumer details, identified by Consumer ID

put/consumer/{consumerId}

Path parameters

consumerIdstring int64 required

EES AIR Consumer ID

Headers

X-EES-AUTH-CLIENT-IDstring string required

Client ID, This will be provided by EES and is unique to the company calling the API.

X-EES-AUTH-HASHstring string required

Request Security Hash, calculated using SHA-256 function from concatenated full Request URI Path with Query String(s), Payload and Client Secret

Connection'close' | 'keep-alive'

This general HTTP header controls (or rather influences) whether the network connection stays open after the current transaction finishes. If the sent value is keep-alive, the connection should stay in a special state, allowing to be reused for subsequent requests to the same server. Please note these connections will be closed after reaching timeout threshold by server (usually after 5 seconds).

Accept-Encoding'' | 'gzip' | 'deflate' | 'gzip,deflate'

This request HTTP header advertises which content encoding (usually a compression algorithm) the calling application is able to understand. The server selects one of the proposals, use it and informs the client of its choice with the Content-Encoding response header. Currently supported gzip and deflate, if request header not present no compression will be used.

X-EES-TRANSACTION-IDstring string

Unique Reference for the API transaction within the calling company.

X-EES-RETRYstring string

This flag denotes the number of attempts that have been made for this request.

X-CUSTOM-SUBSYSTEM-IDstring string

Optional header provided by the calling application for EES AIR to identify what was the external Subsystem Id / Name.

X-CUSTOM-KEYstring string

Optional header(s) provided by the calling application to EES AIR. Please note this header name has to follow pattern X-CUSTOM-*

Request body

titlestring string

Consumer title, i.e. Mr, Mrs

firstNamestring string

Consumer first/given name

secondNamestring string

Consumer last name/surname

dobstring date

Consumer date of birth

gender'MALE' | 'FEMALE'

Consumer gender

emailAddressstring email

Consumer date of birth

mobileNumberstring

Consumer mobile/cell number

addressstring string

Consumer address

referencestring string

Consumer reference

marketingstring boolean

Consumer opted in/out of marketing

status'ACTIVE' | 'PURGED' | 'SUSPENDED' required

Consumer status

Response

OK

consumerIdinteger required

EES AIR Consumer ID

titlestring string

Consumer title, i.e. Mr, Mrs

firstNamestring string

Consumer first/given name

secondNamestring string

Consumer last name/surname

dobstring date

Consumer date of birth

gender'MALE' | 'FEMALE'

Consumer gender

emailAddressstring email

Consumer date of birth

mobileNumberstring

Consumer mobile/cell number

addressstring string

Consumer address

referencestring string

Consumer reference

marketingstring boolean

Consumer opted in/out of marketing

status'ACTIVE' | 'PURGED' | 'SUSPENDED' required

Consumer status