Sign in

v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB
IAM Reseller Clients

Update client's details

patch/iam/clients/{clientId}

Path parameters

clientIdinteger required

Account ID.

Request body

emailstring email

The account email.

companyNamestring

The company name.

custom_idstring nullable

The account custom ID.

namestring nullable

Name of a user who registered the requested account.

phonestring nullable

Phone of a user who registered the requested account.

resellerinteger

ID of the Reseller.

sellerinteger nullable

ID of the Seller.

is_testboolean

System field:

  • true — a test account;
  • false — a production account.

Response

OK.

idinteger required

The account ID.

emailstring email required

The account email.

phonestring nullable

Phone of a user who registered the requested account.

namestring nullable required

Name of a user who registered the requested account.

status'new' | 'trial' | 'trialend' | 'active' | 'integration' | 'paused' | 'preparation' | 'ready' required

Status of the account.

companyNamestring required

The company name.

websitestring

The company website.

currentUserinteger required

ID of the current user.

capabilitiesServiceName[] required

System field. List of services available for the account.

entryBaseDomainstring nullable required

System field. Control panel domain.

signup_process'sign_up_full' | 'sign_up_simple' nullable

System field. Type of the account registration process.

deletedboolean required

The field shows the status of the account:

  • true – the account has been deleted
  • false – the account is not deleted
bill_typestring required

System field. Billing type of the account.

custom_idstring nullable

The account custom ID.

country_codestring

System field. The company country (ISO 3166-1 alpha-2 format).

is_testboolean required

System field:

  • true — a test account;
  • false — a production account.
has_active_adminboolean required

System field.

sellerinteger nullable

ID of the Seller.

resellersinteger

ID of the Reseller.

client_type'common' | 'reseller' | 'sales'

Client's type.

ownernumber

Id of the user, who created client.

Example response

{
  "users": [
    {
      "groups": [
        {
          "id": 1,
          "name": "Administrators"
        }
      ]
    }
  ],
  "paidFeatures": {
    "CDN": [
      {
        "feature_id": 1,
        "name": "paid feature name",
        "service": "CDN"
      }
    ],
    "STREAMING": [
      {
        "feature_id": 2,
        "name": "another paid feature name",
        "service": "STREAMING"
      }
    ]
  },
  "freeFeatures": {
    "CDN": [
      {
        "feature_id": 1,
        "name": "free feature name",
        "service": "CDN"
      }
    ],
    "STREAMING": [
      {
        "feature_id": 2,
        "name": "another free feature name",
        "service": "STREAMING"
      }
    ]
  }
}