사용자 정보 수정

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

사용자의 정보를 수정합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
PUT /v1/api/members/{userId}

요청 헤더

Ncloud Chat API에서 공통으로 사용하는 헤더에 대한 정보는 Ncloud Chat 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
userId String Required 사용자 아이디

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
name String Optional 사용자 이름
profile String Optional 사용자 프로필 이미지 URL
customField String Optional 사용자 정의 필드
notifications Object Optional 푸시 알림 설정
notifications.token String Optional 푸시 토큰
notifications.device String Optional 디바이스 푸시 타입
  • FCM | APNS
notifications.os String Optional 운영 체제 버전
notifications.push Boolean Optional 푸시 알림 허용 여부
  • true | false
    • true: 허용
    • false: 차단
notifications.ad Boolean Optional 광고성 푸시 알림 허용 여부
  • true | false
    • true: 허용
    • false: 차단
notifications.night Boolean Optional 야간 푸시 알림 허용 여부
  • true | false
    • true: 허용
    • false: 차단
notifications.timezone String Optional 시간대

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request PUT 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/guestID2' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}' \
--header 'Content-Type: application/json' \
--data '{
    "name": "guest2V",
    "notifications": {
        "token": "***************************",
        "device": "FCM",
        "os": "25",
        "push": true,
        "ad": false,
        "night": true
    }
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
member Object - 사용자 정보
member.id String - 사용자 아이디
member.project_id String - 프로젝트 아이디
member.member_id String - 사용자 아이디
member.name String - 사용자 이름
member.profile String - 사용자 프로필 이미지
member.memo String - 사용자에 대한 메모
member.country String - 접속 국가
member.remoteip String - 접속 IP 주소
member.adid String - 광고 아이디
member.device String - 디바이스
member.network String - 네트워크
member.version String - 버전
member.model String - 모델
member.deleted Boolean - 탈퇴 여부
  • true | false
    • true: 탈퇴
    • false: 탈퇴 안 함
member.online Boolean - 온라인 여부
  • true | false
    • true: 온라인
    • false: 오프라인
member.customField String - 사용자 정의 필드
member.device_type Array - 디바이스 유형
member.push Boolean - 푸시 알림 허용 여부
  • true | false
    • true: 허용
    • false: 차단
member.memberblock_id String - TBD
member.notifications Object - 푸시 알림 정보
member.notifications.token String - 푸시 토큰
member.notifications.device String - 디바이스 푸시 타입
  • FCM | APNS
member.notifications.os String - 운영 체제 버전
member.notifications.push Boolean - 푸시 알림 허용 여부
  • true | false
    • true: 허용
    • false: 차단
member.notifications.ad Boolean - 광고성 푸시 알림 허용 여부
  • true | false
    • true: 허용
    • false: 차단
member.notifications.night Boolean - 야간 푸시 알림 허용 여부
  • true | false
    • true: 허용
    • false: 차단
member.notifications.timezone String - 시간대
member.logined_at String - 마지막 로그인 일시
  • ISO 8601 형식
member.created_at String - 사용자 등록 일시
  • ISO 8601 형식
member.updated_at String - 정보 수정 일시
  • ISO 8601 형식
member.deleted_at String - 탈퇴 일시
  • ISO 8601 형식
status Integer - 응답 상태
  • 1: 성공
  • 1이 아닌 경우: 실패

응답 상태 코드

Ncloud Chat API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud Chat 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "member": {
        "id": "guestID2",
        "project_id": "8be54b8b-****-****-****-84c0d5df2e9c",
        "member_id": "guestID2",
        "name": "guest2V",
        "profile": null,
        "memo": null,
        "country": "KR",
        "remoteip": null,
        "adid": null,
        "device": null,
        "network": null,
        "version": null,
        "model": null,
        "deleted": false,
        "online": false,
        "customField": "{ageGroup: 20s}",
        "device_type": [],
        "push": null,
        "memberblock_id": null,
        "notifications": {
            "token": "***************************",
            "device": "FCM",
            "os": "25",
            "push": true,
            "ad": false,
            "night": true,
            "timezone": null
        },
        "logined_at": "2025-07-23T11:01:08+09:00",
        "created_at": "2025-07-23T11:01:08+09:00",
        "updated_at": "2025-07-23T11:43:39+09:00",
        "deleted_at": null
    },
    "status": 1
}