delete membership

Description

It deletes permanently a membership register (client user) from the database. This operation can not delete users registered via oauth.

URL

/VERSION/users/USR.FORMAT

Available Format

JSON

HTTP Method

DELETE

Accepted Version

1

Require

Administrator authorization.

Headers

Not applicable.

Parameters

  • access_token: (Required) administrator access_token.
  • USR: (Required) user identifier to delete its membership.

Example

https://api.topoos.com/1/users/673091e0-04a3-485b-9460-d98afaef9a6c.json?access_token=1c75e83d-f912-47c4-b5ce-900dbb0b13a2

Reply

JSON example reply when request success

{
    "code": 200,
    "description": "OK"
}

JSON Response when request error is returned

{
    "code": 405,
    "description": "EXCEPTION_METHOD_NOT_ALLOWED"
}