PATCH
/
v1
/
collectives
/
{collectiveId}
curl --request PATCH \
  --url https://platform.realto.io/api/v1/collectives/{collectiveId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "type": "Household"
}'
{
  "entities": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "properties": "<any>",
  "type": "Household",
  "tenantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
Authorization
string
header
required

Access Token Authentication

Path Parameters

​
collectiveId
string
required

The id of the Collective

Body

The new name and optional new type of the Collective

A request to modify a Collective

​
name
string | null

The name of the Collective

​
type
enum<string>

Types of a Collective.

Available options:
Household,
Fleet,
SolarFarm,
VirtualPowerPlant

Response

200
application/json
OK

A Collective

​
entities
string[] | null

The Entities of the Collective

​
id
string

The id of the Collective

​
name
string | null

The name of the Collective

​
owner
string

The owner of the Collective

​
properties
any | null

The custom properties of the Collective

​
type
enum<string>

Types of a Collective.

Available options:
Household,
Fleet,
SolarFarm,
VirtualPowerPlant
​
tenantId
string

The tenant id the collective belongs to

Was this page helpful?