고객 정보 변경 API

플랫폼 서비스에서 특정 비즈니스의 고객 정보를 변경할 수 있는 API를 제공합니다.

PATCH kit-api/v1/customers/[customerId]

Method: PATCH Endpoint: kit-api/v1/customers/[customerId] Param: customerId는 변경할 고객의 id(숫자) 값을 의미

Example

...kit-api/v1/customers/1

{
  "input": {
    "title": "김철수 매니저",
    "customKey": "B5-k159402"
  }
}

Request Body

Key	Description	Required
input.title	한글, 영어 대소문자, 숫자, -, , _, 등으로 구성된 40자 이하의 새로 생성할 고객 이름 (같은 비즈니스 내 중복불가)	no
input.customKey	영어 대소문자, 숫자, -, _로 구성된 40자 이하의 변경할 키 (같은 비즈니스 내 중복불가)	no

Response

{
  "ok": true,
  "data": {
    "id": 1,
    "title": "김철수 매니저",
    "customKey": "B5-k159402"
  }
}

{
  "ok": false, // api 실패
  "message": "error message", // Error가 존재하면 message(string)로 전달
  "errorCode": "ERROR_CODE"
}

Error Codes

Status Code	Error Code	Description
404	NOT_FOUND_CUSTOMER	존재하지 않는 고객인 경우
409	ALREADY_CUSTOMER_EXISTS	해당 title 또는 customKey를 가진 고객이 이미 존재하는 경우