---
title: "Update"
method: PATCH
path: "/consumer/{consumerId}"
tags: ["Consumer"]
---

# Update

`PATCH /consumer/{consumerId}`

## Request

- Base URL: `https://consumer.uk.eagleeye.com/2.0`
- URL: `https://consumer.uk.eagleeye.com/2.0/consumer/{consumerId}`
- Auth: none declared. Required headers: `X-EES-AUTH-CLIENT-ID`, `X-EES-AUTH-HASH`

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

## Path parameters

- `consumerId` string, int64, required

## Headers

- `X-EES-AUTH-CLIENT-ID` string, string, required
- `X-EES-AUTH-HASH` string, string, required
- `Connection` 'close' | 'keep-alive'
- `Accept-Encoding` '' | 'gzip' | 'deflate' | 'gzip,deflate'
- `X-EES-TRANSACTION-ID` string, string
- `X-EES-RETRY` string, string
- `X-CUSTOM-SUBSYSTEM-ID` string, string
- `X-CUSTOM-KEY` string, string

## Request body

- ConsumerMainEntity
  - `title` string, string: Consumer title, i.e. Mr, Mrs
  - `firstName` string, string: Consumer first/given name
  - `secondName` string, string: Consumer last name/surname
  - `dob` string, date: Consumer date of birth
  - `gender` 'MALE' | 'FEMALE': Consumer gender
  - `emailAddress` string, email: Consumer date of birth
  - `mobileNumber` string: Consumer mobile/cell number
  - `address` string, string: Consumer address
  - `reference` string, string: Consumer reference
  - `pushTokens` object: Consumer push tokens for iOS and/or Android
    - `ios` string, string
    - `android` string, string
  - `marketing` string, boolean: Consumer opted in/out of marketing
  - `segment` object: Consumer segments
    - `key1` string: Data 1 property, up to 255 characters; up to 255 characters for Key 1 Value
    - `key2` string: Data 2 property, up to 255 characters; up to 255 characters for Key 2 Value
  - `meta` object: Additional Consumer details
    - `key1` string: Data 1 property, up to 255 characters; up to 255 characters for Key 1 Value
    - `key2` string: Data 2 property, up to 255 characters; up to 255 characters for Key 2 Value
  - `status` 'ACTIVE' | 'PURGED' | 'SUSPENDED', required: Consumer status

## Response `200`

OK

- object
  - `consumerId` integer, required: EES AIR Consumer ID
  - `title` string, string: Consumer title, i.e. Mr, Mrs
  - `firstName` string, string: Consumer first/given name
  - `secondName` string, string: Consumer last name/surname
  - `dob` string, date: Consumer date of birth
  - `gender` 'MALE' | 'FEMALE': Consumer gender
  - `emailAddress` string, email: Consumer date of birth
  - `mobileNumber` string: Consumer mobile/cell number
  - `address` string, string: Consumer address
  - `reference` string, string: Consumer reference
  - `pushTokens` object: Consumer push tokens for iOS and/or Android
    - `ios` string, string
    - `android` string, string
  - `marketing` string, boolean: Consumer opted in/out of marketing
  - `segment` object: Consumer segments
    - `key1` string: Data 1 property, up to 255 characters; up to 255 characters for Key 1 Value
    - `key2` string: Data 2 property, up to 255 characters; up to 255 characters for Key 2 Value
  - `meta` object: Additional Consumer details
    - `key1` string: Data 1 property, up to 255 characters; up to 255 characters for Key 1 Value
    - `key2` string: Data 2 property, up to 255 characters; up to 255 characters for Key 2 Value
  - `status` 'ACTIVE' | 'PURGED' | 'SUSPENDED', required: Consumer status

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `415`: Unsupported Media Type
- `429`: Too Many Requests
- `500`: Server Error
- `503`: Service Unavailable
- `504`: Gateway Timeout

---

[API](https://skmtc.dev/eagleeye/apis/consumer-api.md) - [All operations](https://skmtc.dev/eagleeye/apis/consumer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/eagleeye/apis/consumer-api/revisions/d4dfe75141c3?raw)