Sync Collections

Manually trigger a sync of this card’s collections to their linked Domo DataSets. Only syncEnabled collections with pending changes are synced. Returns an empty body on success.

By default, only the collections in this card’s own datastore are synced. Set includeRelatedCollections=true to also sync any additional collections listed in the app design’s collectionsMapping — this is useful for designs that declare shared collections with a fixed UUID, which are the same collection reused across all instances of the design.

Collections won’t sync if the collection owner lacks permissions on the target DataSet. If that user is removed from Domo, syncing stops. The new owner must have both Collection ownership and Admin Permissions.

POST /domo/datastores/v1/export

JavaScript

domo.js

// Sync this card's own collections
domo.post('/domo/datastores/v1/export')
  .then(() => console.log('sync started'));

// Also sync related collections (collectionsMapping)
domo.post('/domo/datastores/v1/export?includeRelatedCollections=true')
  .then(() => console.log('sync started'));

Query Parameters

includeRelatedCollections · boolean · default: false

When false (default), syncs only the collections in this card's own datastore. When true, also syncs any additional collections listed in the app design's collectionsMapping alongside this card's own collections. Primarily useful for designs that declare shared collections with a fixed UUID — collections that are the same across all instances of the design.

Body

application/json

The body is of type object.

Response

200

Sync accepted and running asynchronously. No response body is returned.