Skip to content
Developers
Pilot. The API is open to a small number of organisations and may change — every change is in the changelog.

Reference · Report groups

Update a report group

PATCH/v1/sites/{siteId}/report-groups/{code}

Changes a report group. Only the fields sent change. Nothing is deleted: retire it with active false.

Needs Catalogue: writeChanges live data

Path

  • siteIdrequired

    The site, from GET /v1/sites.

    string

  • coderequired

    The record's code.

    string

Headers

  • Authorizationrequired

    An API key from Automation > Access in the Dnero portal, sent as Authorization: Bearer <key>.

    string

Body

  • active

    False to retire it, true to bring it back.

    boolean

  • name

    A new name.

    string · 1–200 characters

Responses

200 OK

  • activerequired

    False for a retired report group.

    boolean

  • coderequired

    The report group's code.

    string

  • namerequired

    The report group's name.

    string

  • orderrequired

    Where it comes in a report, lowest first.

    integer

  • updatedAt

    When it last changed.

    string · date-time