Skip to main content
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": "[email protected]",
  "companyName": "<string>",
  "custom_id": "<string>",
  "name": "<string>",
  "phone": "<string>",
  "reseller": 123,
  "seller": 123,
  "is_test": true
}
'
{
  "id": 123,
  "email": "[email protected]",
  "name": "<string>",
  "status": "new",
  "companyName": "<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>",
  "deleted": true,
  "bill_type": "<string>",
  "is_test": true,
  "has_active_admin": true,
  "users": [
    {
      "id": 123,
      "email": "[email protected]",
      "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"
      ]
    }
  ],
  "phone": "<string>",
  "website": "<string>",
  "signup_process": "sign_up_full",
  "custom_id": "<string>",
  "country_code": "<string>",
  "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
required

The account ID.

​
email
string<email>
required

The account email.

​
name
string | null
required

Name of a user who registered the requested account.

​
status
enum<string>
required

Status of the account.

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

The company name.

​
currentUser
integer
required

ID of the current user.

​
capabilities
enum<string>[]
required

System field. List of services available for the account.

Service's name.

Available options:
CDN,
STORAGE,
STREAMING,
DNS,
DDOS,
CLOUD
​
serviceStatuses
object
required

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

​
paidFeatures
object
required

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
required

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
required

System field. Control panel domain.

​
deleted
boolean
required

The field shows the status of the account:

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

System field. Billing type of the account.

​
is_test
boolean
required

System field:

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

System field.

​
users
object[]

List of account users.

​
phone
string | null

Phone of a user who registered the requested account.

​
website
string

The company website.

​
signup_process
enum<string> | null

System field. Type of the account registration process.

Available options:
sign_up_full,
sign_up_simple
​
custom_id
string | null

The account custom ID.

​
country_code
string

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

​
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.