Change a workspace item in place (Pro)

Change a saved chart, table or dataset in place. The id stays the same, so links and references keep working. Pass the id and only the fields to change. Needs the Pro plan. Charts and tables: title, kind ("chart" or "table"), indicator, places, from, to, frequency; null clears from, to or frequency. Example: {"id": "wsp_3f9a...", "places": ["Texas", "California", "Florida"], "from": null}. Datasets: title, description (null clears it), columns, rows. Rows replace all existing rows; send columns too when their number changes. Returns {id, kind, title, size_bytes, created_at, updated_at, warnings?}.

patch/api/v1/workspace/{id}

Request

  • Base URL: https://invokely.ai
  • URL: https://invokely.ai/api/v1/workspace/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key
    • none

Path parameters

idstring required

Request body

titlestring
kind'chart' | 'table'

Charts and tables only: switch how the view is shown.

indicatorstring

Indicator id from search_indicators, for example "population", "registered_unemployment_rate", "unemployment_rate", "cpi_annual_change", "net_income_per_person".

placesstring[]
fromstring nullable

First period, or null to clear.

tostring nullable

Last period, or null to clear.

frequency'year' | 'half' | 'quarter' | 'month' | 'null' nullable
descriptionstring nullable
columnsstring[]

Response

The changed item: {id, kind, title, size_bytes, created_at, updated_at, warnings?}.

dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.