PATCH
/
iam
/
clients
/
{clientId}
Update client's details
curl --request PATCH \
  --url https://api.gcore.com/iam/clients/{clientId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "jsmith@example.com",
  "companyName": "<string>",
  "custom_id": "<string>",
  "name": "<string>",
  "phone": "<string>",
  "reseller": 123,
  "seller": 123,
  "is_test": true
}'
{
  "id": 123,
  "users": [
    {
      "id": 123,
      "email": "jsmith@example.com",
      "name": "<string>",
      "lang": "de",
      "phone": "<string>",
      "company": "<string>",
      "reseller": 123,
      "client": 123,
      "deleted": true,
      "groups": [
        {
          "id": 1,
          "name": "Administrators"
        }
      ],
      "activated": true,
      "sso_auth": true,
      "two_fa": true,
      "auth_types": [
        "password"
      ]
    }
  ],
  "email": "jsmith@example.com",
  "phone": "<string>",
  "name": "<string>",
  "status": "new",
  "companyName": "<string>",
  "website": "<string>",
  "currentUser": 123,
  "capabilities": [
    "CDN"
  ],
  "serviceStatuses": {
    "CDN": {
      "status": "new",
      "enabled": true
    },
    "CLOUD": {
      "status": "new",
      "enabled": true
    },
    "DDOS": {
      "status": "new",
      "enabled": true
    },
    "DNS": {
      "status": "new",
      "enabled": true
    },
    "STORAGE": {
      "status": "new",
      "enabled": true
    },
    "STREAMING": {
      "status": "new",
      "enabled": true
    }
  },
  "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"
      }
    ]
  },
  "entryBaseDomain": "<string>",
  "signup_process": "sign_up_full",
  "deleted": true,
  "bill_type": "<string>",
  "custom_id": "<string>",
  "country_code": "<string>",
  "is_test": true,
  "has_active_admin": true,
  "seller": 123,
  "resellers": 123,
  "client_type": "common",
  "owner": 123
}

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

clientId
integer
required

Account ID.

Body

application/json
email
string<email>

The account email.

companyName
string

The company name.

custom_id
string | null

The account custom ID.

name
string | null

Name of a user who registered the requested account.

phone
string | null

Phone of a user who registered the requested account.

reseller
integer

ID of the Reseller.

seller
integer | null

ID of the Seller.

is_test
boolean

System field:

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

Response

OK.

id
integer

The account ID.

users
object[]

List of account users.

email
string<email>

The account email.

phone
string | null

Phone of a user who registered the requested account.

name
string | null

Name of a user who registered the requested account.

status
enum<string>

Status of the account.

Available options:
new,
trial,
trialend,
active,
integration,
paused,
preparation,
ready
companyName
string

The company name.

website
string

The company website.

currentUser
integer

ID of the current user.

capabilities
enum<string>[]

System field. List of services available for the account.

serviceStatuses
object

An object of arrays which contains information about all services available for the requested account.

paidFeatures
object

An object of arrays which contains information about paid features available for the requested account.

Example:
{
"CDN": [
{
"feature_id": 1,
"name": "paid feature name",
"service": "CDN"
}
],
"STREAMING": [
{
"feature_id": 2,
"name": "another paid feature name",
"service": "STREAMING"
}
]
}
freeFeatures
object

An object of arrays which contains information about free features available for the requested account.

Example:
{
"CDN": [
{
"feature_id": 1,
"name": "free feature name",
"service": "CDN"
}
],
"STREAMING": [
{
"feature_id": 2,
"name": "another free feature name",
"service": "STREAMING"
}
]
}
entryBaseDomain
string | null

System field. Control panel domain.

signup_process
enum<string> | null

System field. Type of the account registration process.

Available options:
sign_up_full,
sign_up_simple
deleted
boolean

The field shows the status of the account:

  • true – the account has been deleted
  • false – the account is not deleted
bill_type
string

System field. Billing type of the account.

custom_id
string | null

The account custom ID.

country_code
string

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

is_test
boolean

System field:

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

System field.

seller
integer | null

ID of the Seller.

resellers
integer

ID of the Reseller.

client_type
enum<string>

Client's type.

Available options:
common,
reseller,
sales
owner
number

Id of the user, who created client.