Clear Flag a User

Clear Flag a User

DELETE /api/v2/users/{userId}/flags

Clear Flag a User

cURL

curl --request DELETE \
  --url https://apix.us.amity.co/api/v2/users/{userId}/flags \
  --header 'Authorization: Bearer <token>'

200

{
  "userId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "_id": "<string>",
  "path": "<string>",
  "roles": [
    "<string>"
  ],
  "displayName": "<string>",
  "flagCount": 123,
  "hashFlag": {
    "bits": 123,
    "hashes": 123,
    "hash": [
      "<string>"
    ]
  },
  "metadata": {},
  "isDeleted": true
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

userId · string · required

Response

200

application/json

User

userId · string · required

createdAt · string<date-time> · required

updatedAt · string<date-time> · required

_id · string

Private ID of a user. (for real-time event)

path · string

Path of a user. (for real-time event)

roles · string[]

displayName · string

flagCount · integer

hashFlag · object

Show child attributes

metadata · object

isDeleted · boolean