사용자를 변경하는 API입니다.
API 만들기
<도구 | API> 메뉴에서 “USER” 유형 API를 만듭니다.
API 요청
POST 형식으로 요청해야 합니다.
JSON 요청 형식입니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
action | 문자열 | 작업 이름 | 예 | USER_UPDATE |
userId | 문자열 | 변경할 사용자 아이디 | 예 | user01 |
name | 문자열 | 사용자 이름 | 예 | 사용자 01 |
문자열 | 이메일 | 예 | dimdol@3rabbitz.com | |
locale | 문자열 | 언어 | 아니오 | ko | en |
timeZone | 문자열 | 시간대 | 아니오 | Asia/Seoul |
사용자를 변경하는 예제입니다.
{
"action": "USER_UPDATE",
"userId": "user01",
"name": "사용자 01",
"email": "dimdol@3rabbitz.com",
"locale": "ko",
"timeZone": "Asia/Seoul"
}API 응답
USER_UPDATE 응답
JSON 형식의 응답은 다음과 같습니다.
이름 | 유형 | 설명 | 필수 여부 | 예 |
|---|---|---|---|---|
status | 문자열 | 상태 | 예 | success | fail |
errors | Error 객체 배열 | 예외 | 아니오 |
예외 항목
예외 항목은 다음과 같습니다.
예외 | 설명 |
|---|---|
USER_NOT_EXIST | 사용자가 존재하지 않을 때 |
INVALID_PARAMETER | 문자열의 길이 등이 형식에 맞지 않을 때 |
REQUIRED_PARAMETER_MISSING | API 요청에 필수 항목이 없을 때 |
UNSUPPORTED_LOCALE | 해당 언어를 지원하지 않을 때 |
예제
예제입니다.
{
"status": "success"
}