POST api/superadmin/users/{userId}/suspend

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userId

string

Required

Body Parameters

UserActionRequest
NameDescriptionTypeAdditional information
Reason

string

Required

Request Formats

application/json, text/json

Sample:
{
  "Reason": "sample string 1"
}

application/xml, text/xml

Sample:
<UserActionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UCareAPI.Models">
  <Reason>sample string 1</Reason>
</UserActionRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'UserActionRequest'.

Response Information

Resource Description

UserActionResult
NameDescriptionTypeAdditional information
Success

boolean

None.

Message

string

None.

UserId

string

None.

ActionDate

date

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Message": "sample string 2",
  "UserId": "sample string 3",
  "ActionDate": "2026-03-26T03:51:09.7915264+02:00"
}

application/xml, text/xml

Sample:
<UserActionResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UCareAPI.Models">
  <ActionDate>2026-03-26T03:51:09.7915264+02:00</ActionDate>
  <Message>sample string 2</Message>
  <Success>true</Success>
  <UserId>sample string 3</UserId>
</UserActionResult>