Replace Document

Replaces an existing document in a collection — the entire content object is overwritten with whatever you send. To update individual fields without replacing the whole document, use Partially Update Documents instead.

PUT /domo/datastores/v2/collections/{collectionName}/documents/{documentId}

JavaScript

domo.js

const collectionName = 'Students';
const documentId = '402778f6-bc8d-4aa5-a581-e08e3fc98c05';

// PUT replaces the entire document — include all fields, not just the ones changing.
domo.put(`/domo/datastores/v2/collections/${collectionName}/documents/${documentId}`, {
  content: {
    name: 'Harry Potter',
    house: 'Gryffindor',
    wand: { wood: 'holly', core: 'phoenix feather', length: 11 },
    courses: ['Defense Against the Dark Arts', 'Potions', 'Transfiguration'],
    prefect: false
  }
}).then(doc => console.log(doc));

200

{
  "id": "402778f6-bc8d-4aa5-a581-e08e3fc98c05",
  "datastoreId": "daee775a-3be4-410d-ba20-bb0d94ce51cb",
  "collectionId": "2148c830-14c2-478f-bb14-5c3019de46b4",
  "syncRequired": true,
  "owner": "540824222",
  "createdBy": "540824222",
  "createdOn": "2026-07-31T23:09:34.542Z",
  "updatedOn": "2026-08-01T09:14:23.209Z",
  "updatedBy": "540824222",
  "content": {
    "name": "Harry Potter",
    "house": "Gryffindor",
    "wand": {
      "wood": "holly",
      "core": "phoenix feather",
      "length": 11
    },
    "courses": [
      "Defense Against the Dark Arts",
      "Potions",
      "Transfiguration"
    ],
    "prefect": false,
    "enrolledOn": "1991-09-01",
    "lastDetention": "1994-06-08T20:00:00Z"
  }
}

Path Parameters

collectionName · string · required

The name given to the collection in the manifest. Case-sensitive.

documentId · string<uuid> · required

The UUID of the document.

Body

application/json

content · object · required

Updated document content

Response

200

application/json

Document updated successfully. Returns the full updated document.

id · string<uuid>

Unique identifier for the Document

datastoreId · string<uuid>

Unique identifier of the Datastore that this Document's Collection belongs to.

collectionId · string<uuid>

Unique identifier of the Collection this Document belongs to.

syncRequired · boolean

Whether or not this Document needs to be synced by Domo to the associated DataSet; only applies if the syncEnabled option is on for the Collection.

owner · string

User ID of the Document owner.

createdBy · string

User ID of the user who created the Document.

createdOn · string<date-time>

The ISO-8601 timestamp showing when this Document was created.

updatedOn · string<date-time>

The ISO-8601 timestamp showing when this Document was last updated.

updatedBy · string

User ID of the user who last updated the Document.

content · object

The actual Document content