DELETE
/
api
/
v2
/
users
/
{userId}
/
flags
Clear Flag a User
curl --request DELETE \
  --url https://apix.us.amity.co/api/v2/users/{userId}/flags \
  --header 'Authorization: Bearer <token>'
{
  "_id": "<string>",
  "path": "<string>",
  "userId": "<string>",
  "roles": [
    "<string>"
  ],
  "displayName": "<string>",
  "flagCount": 123,
  "hashFlag": {
    "bits": 123,
    "hashes": 123,
    "hash": [
      "<string>"
    ]
  },
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "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

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
​
metadata
object
​
isDeleted
boolean