Remove an Entity from a Collective

API Reference

Core Resources

Onboarding API

Readings API

Commands API

Charge Sessions API

Entity Settings

Offboarding API

DELETE

collectives

{collectiveId}

entities

{entityId}

curl --request DELETE \
  --url https://platform.realto.io/api/v1/collectives/{collectiveId}/entities/{entityId} \
  --header 'Authorization: Bearer <token>'

{
  "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

entityId

string

required

The id of the Entity

Response

200

application/json

A Collective

Add an Entity to a Collective List all members of a Collective

curl --request DELETE \
  --url https://platform.realto.io/api/v1/collectives/{collectiveId}/entities/{entityId} \
  --header 'Authorization: Bearer <token>'

{
  "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"
}