PATCH api/v1/admin/users/{id}/access

Give a user admin access if the user specified is a standard user or remove admin access from a user if the user specified has already got admin access.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The user to promote or demote.

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

The new status of the user.

TwoSms.CustomerPortalRole.API.Misc.ResponseOfSystem.String
NameDescriptionTypeAdditional information
Error

TwoSms.CustomerPortalRole.API.Misc.Error

None.

ResponseData

TwoSms.CustomerPortalRole.API.Misc.ResponseDataOfSystem.String

None.

Response Formats

application/json, text/json

Sample:
{
  "Error": {
    "ErrorCode": "sample string 1",
    "ErrorReason": "sample string 2"
  },
  "ResponseData": {
    "Identification": {
      "UserId": "sample string 1"
    },
    "Result": "sample string 1",
    "Detail": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<ResponseOfString xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Error>
    <ErrorCode>sample string 1</ErrorCode>
    <ErrorReason>sample string 2</ErrorReason>
  </Error>
  <ResponseData>
    <Result>sample string 1</Result>
    <Identification>
      <UserId>sample string 1</UserId>
    </Identification>
    <Detail>sample string 2</Detail>
  </ResponseData>
</ResponseOfString>