/api/reseller/users/{userId}/edit

POST

/api/reseller/users/{userId}/edit

curl --request POST \
  --url https://dashboard.residential.rayobyte.com/api/reseller/users/9ee3d294-6f1e-489c-9b9b-e25e9a4e37a8/edit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "status": "ACTIVE", "description": "SERP scraping" }'

• Main API host

Edit Sub-user details

The API allows you to change some Sub-user data such as status, balance and description in a single API request. In the future, the API will also allow Sub-user passwords to be changed. The call accepts a JSON object with the fields status (available values are “ACTIVE” and “SUSPENDED”), balance (the value is set in kilobytes) and description. All fields are optional.

Note! In this API call, the “balance” field specifies the user’s final balance to be set, not the amount of traffic to be added.

Important! To activate/deactivate Sub-users, as well as to change their balances, it is recommended to use separate available API calls.

Authorizations

• bearerAuth

Parameters

Path Parameters

userId

required

string

Proxy User ID

Example

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

Request Body^required

Media typeapplication/json

object

status

Sub-user status to be set.

string

Allowed values: ACTIVE SUSPENDED

balance

Traffic balance ib Kb

number

description

Short description of the account.

string

>= 2 characters <= 1024 characters

Examples

Valid input example

{
  "status": "ACTIVE",
  "description": "SERP scraping"
}

Passed status is invalid

{
  "status": "ban"
}

Invalid authorization data (account does not exist or access token is expired)

Not authorized.

Responses

200

Proxy User account is successfully updated

Media typeapplication/json

object

status

string

Allowed values: SUCCESS

date

string

Examples

ExampleSuccess

Proxy User is successfully updated

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

401

Not authorized

Media typetext/html

string

Examples

ExampleNot authorized

Not authorized

Not authorized.

500

API call failed

Media typeapplication/json

object

status

string

Allowed values: FAIL

date

string

error

string

Examples

ExampleInternal error

An unexpected error occurred while processing the request.

{
  "status": "FAIL",
  "date": "Mon, 1 Jan 2022 12:00:00 GMT",
  "error": "Internal server error"
}