---
title: "PATCH /api/v1/customers/{customerKey}"
method: PATCH
path: "/api/v1/customers/{customerKey}"
tags: ["Customers"]
---

# PATCH /api/v1/customers/{customerKey}

`PATCH /api/v1/customers/{customerKey}`

## Request

- Base URL: `https://api.simplelocalize.io`
- URL: `https://api.simplelocalize.io/api/v1/customers/{customerKey}`
- Auth: API key in header `X-SimpleLocalize-Token`
- TypeScript: <https://skmtc.dev/simplelocalize/apis/simplelocalize-api/docs/api/v1/customers/:customerKey/patch.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `customerKey` string, required

## Headers

- `X-SimpleLocalize-Token` string, required

## Request body

- CustomerUpdateRequestV1
  - `key` string
  - `displayName` string
  - `description` string

## Response `200`

OK

- object
  - `msg` string
  - `status` integer
  - `data` CustomerDetailsResponseV1
    - `key` string
    - `displayName` string
    - `description` string

## Other responses

- `400`: Bad Request
- `402`: Payment Required
- `403`: Forbidden
- `404`: Not Found
- `409`: Conflict
- `429`: Too Many Requests
- `500`: Internal Server Error

## Changes

- **2026-11-07** `67a25a25863a`: 2 warning, 2 info
  - the `description` request property's maxLength was set to `255`
  - the `key` request property's maxLength was set to `40`
  - added the new optional request property `displayName`
  - added the optional property `data/displayName` to the response with the `200` status
- **2025-11-12** `0329534cd557`: 16 info
  - the endpoint scheme security `Project API Key` was added to the API
  - the endpoint scheme security `apiKey` was removed from the API
  - added the optional property `title` to the response with the `400` status
  - added the optional property `title` to the response with the `402` status
  - …12 more
- **2025-04-19** `5475c7163be9`: 7 info
  - added the optional property `code` to the response with the `400` status
  - added the optional property `code` to the response with the `402` status
  - added the optional property `code` to the response with the `403` status
  - added the optional property `code` to the response with the `404` status
  - …3 more

[Operation history](https://skmtc.dev/simplelocalize/apis/simplelocalize-api/changes/api/v1/customers/:customerKey/patch.md)

---

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