Update Collection

Update one or more fields on a collection. All request body fields are optional — only the fields you include are changed.

PUT /api/datastores/v1/collections/{collectionId}

cURL

rename

curl --request PUT \
  --url https://{instance}.domo.com/api/datastores/v1/collections/{collectionId} \
  --header 'Content-Type: application/json' \
  --header 'X-DOMO-Developer-Token: <api-key>' \
  --data '
{
  "name": "My new name"
}
'

200

{
  "id": "232e6d6c-46e9-49b6-a137-8933f0f05999",
  "datastoreId": "39b88a97-8247-4c0d-ba1d-8ed78d1a6680",
  "defaultPermissions": null,
  "requiredAuthorities": null,
  "owner": 870010733,
  "name": "users",
  "datasourceId": null,
  "schema": {
    "columns": [
      {
        "type": "STRING",
        "name": "username"
      },
      {
        "type": "STRING",
        "name": "email"
      }
    ]
  },
  "filters": null,
  "syncEnabled": true,
  "syncRequired": false,
  "fullReplaceRequired": false,
  "lastSync": null,
  "createdOn": "2024-01-15T18:42:30.115Z",
  "updatedOn": "2024-01-15T18:42:30.115Z",
  "updatedBy": 870010733
}

Authorizations

X-DOMO-Developer-Token · string · header · required

Domo Developer Token for authentication.

Path Parameters

collectionId · string · required

The ID of the collection to update.

Body

application/json

All fields are optional. Only the fields you include are updated; omitted fields are left unchanged.

name · string

New name for the collection.

schema · object

Updated column schema for this collection. Required before enabling DataSet sync. Requires admin privilege. Valid column types: STRING, LONG, DECIMAL, DOUBLE, DATE, DATETIME. The legacy field name schemaJson is also accepted.

Show child attributes

syncEnabled · boolean

Whether to enable periodic syncing of documents to a linked Domo DataSet. Returns a 400 if set to true and the collection has no schema — set schema first.

fullReplaceRequired · boolean

Whether the next DataSet sync should fully replace existing rows rather than upsert.

defaultPermissions · string | null

Comma-separated default permission set for new app grants on this collection. READ is always appended even if omitted. When null or blank, defaults to READ,CREATE_CONTENT,READ_CONTENT,UPDATE_CONTENT,DELETE_CONTENT. Valid values: ADMIN, SHARE, DELETE, WRITE, READ, CREATE_CONTENT, READ_CONTENT, UPDATE_CONTENT, DELETE_CONTENT. Requires admin privilege.

owner · integer

Numeric user ID to set as the collection owner. Requires admin privilege to change.

requiredAuthorities · object | null

Maps CollectionOperation names to arrays of authority strings. When set, only users with matching authorities may perform the corresponding operation. Requires admin privilege.

filters · object[] | null

Array of document-level filter predicates applied to read operations on this collection. Requires WRITE permission on the collection.

Response

200

application/json

OK

id · string<uuid>

Unique identifier for the collection.

datastoreId · string<uuid>

ID of the datastore this collection belongs to.

defaultPermissions · any | null

Comma-separated default permission set for new app grants on this collection, or null if not set.

requiredAuthorities · any | null

Maps CollectionOperation names to required authority strings, or null if not set.

owner · integer

User ID of the collection owner.

name · string

Name of the collection.

datasourceId · string | null

ID of the linked Domo DataSet, or null if not yet linked.

schema · object

Show child attributes

filters · any | null

Array of document-level filter predicates applied to read operations, or null if not set.

syncEnabled · boolean

Whether documents are periodically synced to the linked DataSet.

syncRequired · boolean

Whether a sync is pending.

fullReplaceRequired · boolean

lastSync · string<date-time> | null

createdOn · string<date-time>

updatedOn · string<date-time>

updatedBy · integer