Restore user

Prev Next

Available in Classic and VPC

Restore user information.

Request

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

Method URI
DELETE /v1/api/members/{userId}/restore

Request headers

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

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
userId String Required User ID

Request example

The request example is as follows:

curl --location --request DELETE 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/members/guestId2/restore' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}'

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.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": "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
}