Register user

Available in Classic and VPC

Request

This section describes the request format. The method and URI are as follows:

Method	URI
POST	/v1/api/members

Request headers

For information about the headers common to all Ncloud Chat APIs, see Ncloud Chat request headers.

Request body

You can include the following data in the body of your request:

Field	Type	Required	Description
`userId`	String	Required	User ID Enter 4 to 128 characters using a combination of English letters, numbers, and the special characters "-" and "_".
`name`	String	Required	User name
`profile`	String	Optional	User profile image URL
`customField`	String	Optional	User-defined field
`notifications`	Object	Optional	Set push notifications.

Request example

The request example is as follows:

curl --location --request POST 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/members' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}' \
--header 'Content-Type: application/json' \
--data '{
    "userId": "guestID4",
    "name": "guest4",
    "customField": "{ageGroup: 20s}",
    "notifications": {}
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`member`	Object	-	User information
`member.id`	String	-	User ID
`member.project_id`	String	-	Project ID
`member.member_id`	String	-	User ID
`member.name`	String	-	User name
`member.profile`	String	-	User profile image
`member.memo`	String	-	Note for user
`member.country`	String	-	Country connected
`member.remoteip`	String	-	Access IP address
`member.adid`	String	-	Ad ID
`member.device`	String	-	Device
`member.network`	String	-	Network
`member.version`	String	-	Version
`member.model`	String	-	Model
`member.deleted`	Boolean	-	Withdrawal status `true` \| `false` `true`: Unsubscribed `false`: Not unsubscribed
`member.online`	Boolean	-	Online status `true` \| `false` `true`: Online `false`: Offline
`member.customField`	String	-	User-defined field
`member.device_type`	Array	-	Device type
`member.push`	Boolean	-	Whether to allow push notifications `true` \| `false` `true`: Allow `false`: Block
`member.memberblock_id`	String	-	TBD
`member.notifications`	Object	-	Push notification information
`member.notifications.token`	String	-	Push token
`member.notifications.device`	String	-	Device push type `FCM` \| `APNS`
`member.notifications.os`	String	-	Operating system version
`member.notifications.push`	Boolean	-	Whether to allow push notifications `true` \| `false` `true`: Allow `false`: Block
`member.notifications.ad`	Boolean	-	Whether to allow ad push notifications `true` \| `false` `true`: Allow `false`: Block
`member.notifications.night`	Boolean	-	Whether to allow night push notifications `true` \| `false` `true`: Allow `false`: Block
`member.notifications.timezone`	String	-	Time zone
`member.logined_at`	String	-	Last login date and time ISO 8601 format
`member.created_at`	String	-	User registration date and time ISO 8601 format
`member.updated_at`	String	-	Information modification date and time ISO 8601 format
`member.deleted_at`	String	-	Withdrawal date and time ISO 8601 format
`status`	Integer	-	Response status `1`: Success If not `1`: Failure

Response status codes

For information about the HTTP status codes common to all Ncloud Chat APIs, see Common Ncloud Chat response status codes.

Response example

The response example is as follows:

{
    "member": {
        "id": "guestID4",
        "project_id": "8be54b8b-****-****-****-84c0d5df2e9c",
        "member_id": "guestID4",
        "name": "guest4",
        "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": null,
            "device": null,
            "os": null,
            "push": null,
            "ad": null,
            "night": null,
            "timezone": null
        },
        "logined_at": "2025-07-23T11:04:17+09:00",
        "created_at": "2025-07-23T11:04:17+09:00",
        "updated_at": "2025-07-23T11:04:17+09:00",
        "deleted_at": null
    },
    "status": 1
}