Skip to main content
PATCH
/
v1
/
collectives
/
{collectiveId}
Update a Collective
curl --request PATCH \
  --url https://api.traxes.io/connect/v1/collectives/{collectiveId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "Fleet"
}
'
{
  "entities": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "owner": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "properties": "<unknown>",
  "type": "Fleet"
}

Documentation Index

Fetch the complete documentation index at: https://docs.der-connect.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Access Token Authentication

Path Parameters

​
collectiveId
string<uuid>
required

The id of the Collective

Body

application/json

A request to modify a Collective

​
name
string | null

The name of the Collective

​
type
enum<string>
Available options:
Fleet,
SolarFarm,
VirtualPowerPlant

Response

OK

A Collective

​
entities
string<uuid>[] | null

The Entities of the Collective

​
id
string<uuid>

The id of the Collective

​
name
string | null

The name of the Collective

​
owner
string<uuid>

The owner of the Collective

​
properties
any | null

The custom properties of the Collective

​
type
enum<string>
Available options:
Fleet,
SolarFarm,
VirtualPowerPlant