BRP Connect API

PATCH /v1/customers/{customer_id}

Status, Bilanzkreis oder Metadaten eines Kunden aktualisieren. Damit wird ein ausstehender Kunde aktiviert, ein bestehender deaktiviert, sein Bilanzkreis gewechselt oder seine eigenen Metadaten gepflegt. Metadaten werden beim Aktualisieren zusammengeführt — nur übergebene Schlüssel werden ergänzt oder überschrieben. Um einen Schlüssel zu entfernen, setzen Sie seinen Wert auf null. Erforderlicher Scope: customers:write

Als Markdown anzeigen
PATCH
/v1/customers/{customer_id}
X-Api-Key<token>

In: header

Path Parameters

customer_idstring

Kennung des Kunden

status?string

Neuer Kundenstatus

Value in"pending" | "active" | "deactivated"
balance_group?BalanceGroup

Eine Bilanzkreis-Zuordnung

metadata?object

Schlüssel-Wert-Paare, die in die vorhandenen Metadaten übernommen werden

Empty Object

Response Body

curl -X PATCH "https://api.otark.energy/v1/customers/cust_r8s9t0u1" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "cust_r8s9t0u1",
  "name": "SolarDach GmbH",
  "status": "active",
  "balance_group": {
    "eic": "11YSOLARDACH--A",
    "tso": "DE_AMPRION"
  },
  "metadata": {
    "customer_number": "KD-2026-0815",
    "cost_center": "CC-4200",
    "region": "NRW"
  },
  "assigned_at": "2026-01-10T09:00:00Z",
  "activated_at": "2026-01-10T11:30:00Z",
  "created_at": "2026-01-10T09:00:00Z"
}

{
  "type": "https://brp.otark.energy/errors/validation",
  "title": "Validierung fehlgeschlagen",
  "status": 400,
  "instance": "/v1/customers/cust_r8s9t0u1",
  "errors": [
    {
      "field": "balance_group.tso",
      "code": "invalid_enum_value",
      "message": "Invalid enum value. Expected 'DE_AMPRION' | 'DE_TENNET' | 'DE_TRANSNET_BW' | 'DE_50HERTZ', received 'INVALID'"
    }
  ]
}

{
  "type": "https://brp.otark.energy/errors/invalid_api_key",
  "title": "Ungültiger API-Schlüssel",
  "status": 401
}

{
  "type": "https://brp.otark.energy/errors/insufficient_scopes",
  "title": "Unzureichende Scopes des API-Schlüssels",
  "status": 403,
  "detail": "Missing scope: customers:write. Please create a new API key with the required scopes."
}

{
  "type": "https://brp.otark.energy/errors/customer_not_found",
  "title": "Kunde nicht gefunden",
  "status": 404,
  "instance": "/v1/customers/cust_r8s9t0u1"
}

{
  "type": "https://brp.otark.energy/errors/already_active",
  "title": "Kunde bereits aktiv",
  "status": 409
}