MENU
      Member
        • PDF

        Member

        • PDF

        Article summary

        Description

        This section introduces APIs for creating, editing, and deleting member information.

        Get member API

        You can search all of your member information.

        Request URL

        GET https://dashboard-api.ncloudchat.naverncp.com/v1/api/members
        HTTP

        Request headers

        HeaderDescription
        x-project-id- Dashboard > Settings > General > Project ID
        x-api-key- Dashboard > Settings > General > API key

        Request path parameter

        ParameterTypeRequiredDescription
        channelIdStringOChannel ID

        Request query parameter

        ParameterTypeRequiredDescription
        filterStringOEnter {} by default. Filters allow you to search for some fields
        sortStringXDefine the filter for the fields you want to sort
        optionStringXSee the below when there are options

        Request example

        curl -X 'GET' \
          'https://dashboard-api.ncloudchat.naverncp.com/v1/api/members?filter=%7B%7D&sort=%7B%22created_at%22%3A%22-1%22%7D&option=%7B%22offset%22%3A0%2C%22per_page%22%3A1%7D' \
          -H 'accept: application/json' \
          -H 'x-project-id: 339c2b1c-d35b-47f2-828d-5f0xxxxxxxxxx' \
          -H 'x-api-key: 4302925661f70ce7c1406c59543f2546d26xxxxxxxxxx'
        Plain text

        Response example (normal)

        [
          {
            "id": "750610c9-3fb9-42b0-8355-XXXXXXXXX",
            "project_id": "339c2b1c-d35b-47f2-828d-5f0xxxxxxxxxx",
            "member_id": "750610c9-3fb9-42b0-8355-XXXXXXXXX",
            "name": "Nickname",
            "profile": "http://XXXXXX",
            "memo": null,
            "country": "KR",
            "remoteip": "116.124.XX.XXX",
            "adid": null,
            "device": null,
            "network": null,
            "version": null,
            "model": null,
            "deleted": false,
            "online": false,
            "customField": null,
            "device_type": [],
            "push": true,
            "memberblock_id": null,
            "logined_at": "2022-06-15T09:30:28+09:00",
            "created_at": "2021-12-06T19:36:59+09:00",
            "updated_at": "2022-06-27T15:17:31+09:00",
            "deleted_at": null
          }
        ]
        Plain text

        Response

        It is returned as an HTTP status code and forwarded as body information.

        HTTP status codeResponse MessageDescription
        200OKGeneral successful request
        400Bad RequestUsed for general request failure (usually used to respond to a request format that the server can't understand)
        500Internal Server Error- Response code for general server errors
        - While 4XX error codes represent client-side errors
        - 5xx error codes represent server-side errors

        Get individual member information API

        You can get specific individual member information.

        Request URL

        GET https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/{userId}
        HTTP

        Request headers

        HeaderDescription
        x-project-id- Dashboard > Settings > General > Project ID
        x-api-key- Dashboard > Settings > General > API key

        Request path parameter

        ParameterTypeRequiredDescription
        userIdStringYMember ID

        Request example

        curl -X 'GET' \
          'https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/f8002d46-3064-4d42-XXXX-XXXXXXXXX' \
          -H 'accept: application/json' \
          -H 'x-project-id: 339c2b1c-d35b-47f2-XXXX-XXXXXXXXX' \
          -H 'x-api-key: 4302925661f70ce7c1406c59543f2546dXXXXXXXX'
        Plain text

        Response example (normal)

        {
          "id": "f8002d46-3064-4d42-XXXX-XXXXXXXXX",
          "project_id": "339c2b1c-d35b-47f2-828d-xxxxxxxxxx",
          "member_id": "f8002d46-3064-4d42-XXXX-XXXXXXXXX",
          "name": "Nickname222",
          "profile": "image_url",
          "memo": null,
          "country": "KR",
          "remoteip": "116.124.XXX.XXX",
          "adid": null,
          "device": null,
          "network": null,
          "version": null,
          "model": null,
          "deleted": false,
          "online": false,
          "customField": null,
          "device_type": [],
          "push": true,
          "memberblock_id": null,
          "logined_at": "2022-06-15T09:30:28+09:00",
          "created_at": "2021-12-06T19:36:59+09:00",
          "updated_at": "2023-04-26T13:16:37+09:00",
          "deleted_at": null
        }
        Plain text

        Response

        It is returned as an HTTP status code and forwarded as body information.

        HTTP status codeResponse MessageDescription
        200OKGeneral successful request
        400Bad RequestUsed for general request failure (usually used to respond to a request format that the server can't understand)
        500Internal Server Error- Response code for general server errors
        - While 4XX error codes represent client-side errors
        - 5xx error codes represent server-side errors

        Create member API

        You can send the Create member API.

        Request URL

        POST https://dashboard-api.ncloudchat.naverncp.com/v1/api/members
        HTTP

        Request headers

        HeaderDescription
        x-project-id- Dashboard > Settings > General > Project ID
        x-api-key- Dashboard > Settings > General > API key

        Request body parameter

        ParameterTypeRequiredDescription
        userIdStringYID to create (4 - 128 characters allowed)
        nameStringYNickname or name
        customFieldStringNcustomField

        Request example

        curl -X 'POST' \
          'https://dashboard-api.ncloudchat.naverncp.com/v1/api/members' \
          -H 'accept: application/json' \
          -H 'x-project-id: 339c2b1c-d35b-47f2-XXXX-XXXXXXXX' \
          -H 'x-api-key: 4302925661f70ce7c1406c59543f254XXXXXXXX' \
          -H 'Content-Type: application/json' \
          -d '{
          "userId": "guestId",
          "name": "111222333444",
          "customField": "customField"
        }'
        Plain text

        Response example (normal)

        {
          "member": {
            "id": "guestId",
            "project_id": "339c2b1c-d35b-47f2-XXXX-XXXXXXXX",
            "member_id": "guestId",
            "name": "111222333444",
            "profile": null,
            "memo": null,
            "country": "NO",
            "remoteip": null,
            "adid": null,
            "device": null,
            "network": null,
            "version": null,
            "model": null,
            "deleted": false,
            "online": false,
            "customField": "customField",
            "device_type": [],
            "push": true,
            "memberblock_id": null,
            "logined_at": "2023-04-26T13:10:25+09:00",
            "created_at": "2023-04-26T13:10:25+09:00",
            "updated_at": "2023-04-26T13:10:25+09:00",
            "deleted_at": null
          },
          "status": 1
        }
        Plain text

        Response

        It is returned as an HTTP status code and forwarded as body information.

        HTTP status codeResponse MessageDescription
        200OKGeneral successful request
        400Bad RequestUsed for general request failure (usually used to respond to a request format that the server can't understand)
        500Internal Server Error- Response code for general server errors
        - While 4XX error codes represent client-side errors
        - 5xx error codes represent server-side errors

        Delete member API

        Delete specific member information.

        Request URL

        DELETE https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/:userId
        HTTP

        Request headers

        HeaderDescription
        x-project-id- Dashboard > Settings > General > Project ID
        x-api-key- Dashboard > Settings > General > API key

        Request path parameter

        ParameterTypeRequiredDescription
        userIdStringYMember ID

        Request example

        curl -X 'DELETE' \
          https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/guestId2' \
          -H 'accept: */*' \
          -H 'x-project-id: 339c2b1c-d35b-47f2-XXXX-XXXXXXXXX' \
          -H 'x-api-key: 4302925661f70ce7c1406c59543f2546dXXXXXXXXXXX'
        Plain text

        Response example (normal)

        {
          "member": {
            "id": "guestId2",
            "project_id": "339c2b1c-d35b-47f2-XXXX-XXXXXXXXX",
            "member_id": "guestId2",
            "name": "111222333444",
            "profile": null,
            "memo": null,
            "country": "NO",
            "remoteip": null,
            "adid": null,
            "device": null,
            "network": null,
            "version": null,
            "model": null,
            "deleted": false,
            "online": false,
            "customField": "customField",
            "device_type": [],
            "push": true,
            "memberblock_id": null,
            "logined_at": "2023-04-26T13:42:04+09:00",
            "created_at": "2023-04-26T13:42:04+09:00",
            "updated_at": "2023-04-26T13:42:04+09:00",
            "deleted_at": null
          },
          "status": 1
        }
        Plain text

        Response

        It is returned as an HTTP status code and forwarded as body information.

        HTTP status codeResponse MessageDescription
        200OKGeneral successful request
        400Bad RequestUsed for general request failure (usually used to respond to a request format that the server can't understand)
        500Internal Server Error- Response code for general server errors
        - While 4XX error codes represent client-side errors
        - 5xx error codes represent server-side errors

        Restore member API

        Restore information of a deleted member.

        Request URL

        DELETE https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/:userId/restore
        HTTP

        Request headers

        HeaderDescription
        x-project-id- Dashboard > Settings > General > Project ID
        x-api-key- Dashboard > Settings > General > API key

        Request path parameter

        ParameterTypeRequiredDescription
        userIdStringYMember ID

        Request example

        curl -X 'DELETE' \
          https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/guestId2/restore' \
          -H 'accept: */*' \
          -H 'x-project-id: 339c2b1c-d35b-47f2-XXXX-XXXXXXXXX' \
          -H 'x-api-key: 4302925661f70ce7c1406c59543f2546dXXXXXXXXXXX'
        Plain text

        Response example (normal)

        {
          "member": {
            "id": "guestId2",
            "project_id": "339c2b1c-d35b-47f2-XXXX-XXXXXXXXX",
            "member_id": "guestId2",
            "name": "111222333444",
            "profile": null,
            "memo": null,
            "country": "NO",
            "remoteip": null,
            "adid": null,
            "device": null,
            "network": null,
            "version": null,
            "model": null,
            "deleted": false,
            "online": false,
            "customField": "customField",
            "device_type": [],
            "push": true,
            "memberblock_id": null,
            "logined_at": "2023-04-26T13:42:04+09:00",
            "created_at": "2023-04-26T13:42:04+09:00",
            "updated_at": "2023-04-26T13:42:04+09:00",
            "deleted_at": null
          },
          "status": 1
        }
        Plain text

        Response

        It is returned as an HTTP status code and forwarded as body information.

        HTTP status codeResponse MessageDescription
        200OKGeneral successful request
        400Bad RequestUsed for general request failure (usually used to respond to a request format that the server can't understand)
        500Internal Server Error- Response code for general server errors
        - While 4XX error codes represent client-side errors
        - 5xx error codes represent server-side errors

        Register user token

        Register the user's push token and change the listening status.

        Request URL

        POST https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/:userId/notification
        HTTP

        Request headers

        HeaderDescription
        x-project-idDashboard > Settings > General > Project ID
        x-api-keyDashboard > Settings > General > API key

        Request path parameters

        ParameterTypeRequiredDescription
        userIdStringYMember ID

        Request body parameter

        ParameterTypeRequiredDescription
        tokenStringNPush token
        deviceStringNDevice push type (FCM, APNS)
        osStringNOperating system type
        pushBooleanNWhether to receive push messages (true: receive all messages)
        adBooleanNWhether to receive ad messages (true: receive all messages)
        nightBooleanNWhether to receive night messages
        timezoneStringNTime zone

        Request example

        curl -X 'POST' \
          'https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/guestId1/notification' \
          -H 'accept: */*' \
          -H 'x-project-id: 339c2b1c-d35b-47f2-XXXX-XXXXXXXXX' \
          -H 'x-api-key: 4302925661f70ce7c1406c59543f2546dXXXXXXXXXXX'
          -H 'Content-Type: application/json' \
          -d '{
          "token": "eSs_u-CVRXSAaZNZe6E47B:APA91bGE-99GKBWXFV2EUO_N__VJtRlyw_fbbj5bIxzslCRn3exMuW9z9lSYEYAKjQUd0OHa0yIL4bEh31iQ9T09OXEqC4nwUCt-C_GS44luMbofSEjCEluhCDQW3luduAAALMf3VC4s",
          "device": "FCM",
          "os": "",
          "push": true,
          "ad": true,
          "night": true
        }'
        Plain text

        Response example (normal)

        {
          "member": {
            "id": "guestId1",
            "notifications": {
              "token": "eSs_u-CVRXSAaZNZe6E47B:APA91bGE-99GKBWXFV2EUO_N__VJtRlyw_fbbj5bIxzslCRn3exMuW9z9lSYEYAKjQUd0OHa0yIL4bEh31iQ9T09OXEqC4nwUCt-C_GS44luMbofSEjCEluhCDQW3luduAAALMf3VC4s",
              "device": "FCM",
              "os": "",
              "push": false,
              "ad": true,
              "night": true,
              "timezone": null
            }
          },
          "status": 1
        }
        Plain text

        Response

        It is returned as an HTTP status code and forwarded as body information.

        HTTP status codeResponse MessageDescription
        200OKGeneral successful request
        400Bad RequestUsed for general request failure (usually used to respond to a request format that the server can't understand)
        500Internal Server Error- Response code for general server errors
        - 4XX error codes used to represent client-side errors
        - 5xx error codes represent server-side errors

        Get user token

        Get the user's push token and the push receipt status.

        Request URL

        GET https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/:userId/notification
        HTTP

        Request headers

        HeaderDescription
        x-project-id- Dashboard > Settings > General > Project ID
        x-api-key- Dashboard > Settings > General > API key

        Request path parameter

        ParameterTypeRequiredDescription
        userIdStringYMember ID

        Request example

        curl -X 'POST' \
          'https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/guestId1/notification' \
          -H 'accept: */*' \
          -H 'x-project-id: 339c2b1c-d35b-47f2-XXXX-XXXXXXXXX' \
          -H 'x-api-key: 4302925661f70ce7c1406c59543f2546dXXXXXXXXXXX'
        Plain text

        Response example (normal)

        {
          "member": {
            "id": "guestId1",
            "notifications": {
              "token": "eSs_u-CVRXSAaZNZe6E47B:APA91bGE-99GKBWXFV2EUO_N__VJtRlyw_fbbj5bIxzslCRn3exMuW9z9lSYEYAKjQUd0OHa0yIL4bEh31iQ9T09OXEqC4nwUCt-C_GS44luMbofSEjCEluhCDQW3luduAAALMf3VC4s",
              "device": "FCM",
              "os": "",
              "push": false,
              "ad": true,
              "night": true,
              "timezone": null
              }
            }
        }
        Plain text

        Response

        It is returned as an HTTP status code and forwarded as body information.

        HTTP status codeResponse MessageDescription
        200OKGeneral successful request
        400Bad RequestUsed for general request failure (usually used to respond to a request format that the server can't understand)
        500Internal Server Error- Response code for general server errors
        - 4XX error codes used to represent client-side errors
        - 5xx error codes represent server-side errors

        Was this article helpful?

        What's Next
        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.