Collections

Rename, reorder, relabel, link refresh

patch/collections/{collection_id}

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/collections/{collection_id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Path parameters

collection_idinteger required

Request body

namestring nullable
descriptionstring nullable
orderinteger[] nullable

Every dashboard id in the new order

tab_labelsobject nullable

dashboard id -> short tab label; empty clears it

automation_idinteger nullable

Link an automation for upload-to-refresh

unlink_automationboolean

Response

Request fulfilled, document follows

idinteger required
namestring required
descriptionstring nullable
urlstring required
project_idinteger required
workspace_idinteger required
rolestring required

'manager' (edits its project) or 'member'

dashboard_countinteger required
member_countinteger nullable

Managers only — a member never sees the roster

cover_urlstring nullable

The first published board's url token, for a thumbnail

shared_by_namestring nullable

Members only: who shared it with them

has_refreshboolean
updated_atstring date-time nullable
automation_idinteger nullable
refresh_folder_resource_idinteger nullable
refresh_datasetsobject[]

Changes

No recorded changes to this operation across all 3 revisions of this API.