ReportsEdit a space

Edit a space

Needs: Reports, Read-write

Edits a space: its name, colour, subfolders, and which insights and dashboards it holds.

Space operations

  • add_subfolder: name, with an optional color.
  • update_subfolder: subfolder_id, with optional name and color.
  • delete_subfolder: subfolder_id. Its items move to the top level of the space.
  • add_item: insight_id or dashboard_id, with an optional subfolder_id. It moves the item here from any other space.
  • remove_item: insight_id or dashboard_id. It leaves every space.
curl -X PATCH "https://app.imploy.com.au/api/integrations/v1/reports/spaces/123" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "operations": [
    {
      "op": "add_item",
      "insight_id": 31
    }
  ]
}'
{
  "updated": 2,
  "...": "the space"
}
PATCH
/reports/spaces/{id}
PATCH
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.
Content-Typestring
Required

The media type of the request body

Options: application/json
namestring

The new name.

colorstring

A folder colour name or hex: Gray, Red, Pink, Purple, Blue, Cyan, Teal, Green, Yellow, Orange or Brown, or a hex value from the sidebar palette. Or null.

operationsarray

Ordered edits. See the list below.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. An organisation access token that starts with imp_at_. Send it as Authorization: Bearer imp_at_XXXX.

Path Parameters

idinteger
Required

The space id.

Body

application/json
namestring

The new name.

colorstring

A folder colour name or hex: Gray, Red, Pink, Purple, Blue, Cyan, Teal, Green, Yellow, Orange or Brown, or a hex value from the sidebar palette. Or null.

operationsarray

Ordered edits. See the list below.

Responses

OK