Update a document by ID.

Beta

PUT

https://api-prod.scoutos.com/v2/collections/:collection_id/documents/:document_id

PUT

/v2/collections/:collection_id/documents/:document_id

1 import { ScoutClient, Scout } from "scoutos";
2 
3 const client = new ScoutClient({ apiKey: "YOUR_API_KEY" });
4 await client.documents.update("collection_id", "document_id", {});

Try it

1 {
2   "data": {
3     "data": {
4       "id": "id",
5       "columns": {
6         "key": "value"
7       },
8       "display_name": "display_name",
9       "content": [
10         {
11           "type": "paragraph",
12           "value": "value"
13         }
14       ]
15     },
16     "created_by": {
17       "type": "user",
18       "details": {
19         "clerk_user_id": "clerk_user_id",
20         "clerk_org_id": "clerk_org_id",
21         "scout_organization_id": "scout_organization_id",
22         "email": {
23           "key": "value"
24         }
25       }
26     },
27     "last_updated_by": {
28       "type": "user",
29       "details": {
30         "clerk_user_id": "clerk_user_id",
31         "clerk_org_id": "clerk_org_id",
32         "scout_organization_id": "scout_organization_id",
33         "email": {
34           "key": "value"
35         }
36       }
37     },
38     "document_id": "document_id",
39     "created_at": "2024-01-15T09:30:00Z",
40     "last_updated_at": "2024-01-15T09:30:00Z"
41   }
42 }

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

collection_idstringRequired

document_idstringRequired

Request

This endpoint expects an object.

idstringOptional

columnsmap from strings to anyOptional

display_namestringOptionalDefaults to Untitled

contentlist of objectsOptional

Response

This endpoint returns an object.

dataobject or null

Authentication

Path parameters

Request

Response

Errors