/api/reseller/users/{userId}/suspend

GET

const url = 'https://dashboard.residential.rayobyte.com/api/reseller/users/9ee3d294-6f1e-489c-9b9b-e25e9a4e37a8/suspend';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://dashboard.residential.rayobyte.com/api/reseller/users/9ee3d294-6f1e-489c-9b9b-e25e9a4e37a8/suspend \
  --header 'Authorization: Bearer <token>'

Suspends the Sub-user’s account and blocks him from accessing the proxy service

The access point allows the Reseller to block the Sub-user from accessing the proxy service. You can reactivate a Sub-user account using the corresponding API call if there is a positive traffic balance.

Authorizations

bearerAuth

Parameters

Path Parameters

userId

required

string

Proxy User ID

Example

9ee3d294-6f1e-489c-9b9b-e25e9a4e37a8

Responses

200

Success

application/json

object

status

string

Allowed values: SUCCESS

date

string

data

object

Examples

Success

Successfully suspended

{
  "status": "SUCCESS",
  "date": "Mon, 1 Jan 2022 12:00:00 GMT"
}

401

Not authorized

text/html

string

Examples

Not authorized

Not authorized.

500

API call failed

application/json

object

status

string

Allowed values: FAIL

date

string

error

string

Examples

User not found

{
  "status": "FAIL",
  "date": "Mon, 1 Jan 2022 12:00:00 GMT",
  "error": "User not found"
}

Was this page helpful?