Update a Tenant - re.alto Docs

API Reference

Core Resources

Entities
Collectives
Tenants
- The Tenant object
- GET
  Retrieve a Tenant
- GET
  List all Tenants
- PATCH
  Update a Tenant
- GET
  List all Collectives by Tenant
- Members
- Administrators

Onboarding API

Entity Onboarding
Collective Onboarding
Guided Onboarding

Readings API

Readings
Aggregations

Commands API

Charge Sessions API

GET
List all Charge Sessions

Entity Settings

Features
Locations
Battery Capacity
Heated Area
Disaggregators
Custom Properties

Offboarding API

Offboard Entities

PATCH

tenants

{tenantId}

curl --request PATCH \
  --url https://platform.realto.io/api/v1/tenants/{tenantId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>"
}'

{
  "administrators": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "entities": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>"
}

Authorizations

Authorization

string

header

required

Access Token Authentication

Path Parameters

tenantId

string

required

The id of the Tenant

Body

The new name of the Tenant

A request to modify Tenants

name

string | null

The name of the Tenant

Response

200

application/json

A Tenant

administrators

string[] | null

The administrators of the Tenant

entities

string[] | null

The entities of the Tenant

string

The id

name

string | null

The name of the Tenant

Was this page helpful?

List all Tenants List all Collectives by Tenant

curl --request PATCH \
  --url https://platform.realto.io/api/v1/tenants/{tenantId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>"
}'

{
  "administrators": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "entities": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>"
}