Skip to main content
PUT
/
platform
/
admin
/
tenant
cURL
curl --request PUT \
  --url https://api.example.com/platform/admin/tenant \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": 1,
  "name": "Acme Corporation Updated",
  "tenantAdminEmail": "[email protected]",
  "isEnabled": true,
  "shouldBeDeleted": false,
  "shouldResendInvitation": false
}
'
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

Query Parameters

​
api-version
string | null

Body

application/json

Request to update an existing tenant organization.

​
id
integer<int64>

Identifier of the tenant to update.

Example:

1

​
name
string

Updated name of the tenant.

Example:

"Acme Corporation Updated"

​
tenantAdminEmail
string

Email address of the tenant administrator.

Example:

"[email protected]"

​
isEnabled
boolean

True to enable the tenant, false to disable.

Example:

true

​
shouldBeDeleted
boolean

True to mark the tenant for deletion.

Example:

false

​
shouldResendInvitation
boolean

True to resend the invitation email to the tenant administrator.

Example:

false

Response

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object

The result value returned when the operation is successful.

Example:
{
  "id": 42,
  "name": "Acme Corporation",
  "accountsCount": 5,
  "configurationsCount": 12,
  "walletsCount": 8,
  "pendingUsersCount": 2,
  "activeUsersCount": 15,
  "isEnabled": true,
  "firstAdminPendingEmail": "[email protected]"
}