Update a document by ID.

Beta

PUT

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

PUT

/v2/collections/:collection_id/tables/:table_id/documents/:document_id

1 from scoutos import Scout
2 
3 client = Scout(
4     api_key="YOUR_API_KEY",
5 )
6 client.documents.update(
7     collection_id="collection_id",
8     document_id="document_id",
9     table_id="table_id",
10     request={},
11 )

Try it

1 {
2   "data": {
3     "document_id": "document_id",
4     "data": {},
5     "document_data_id": "document_data_id",
6     "created_at": "created_at",
7     "last_updated_at": "last_updated_at",
8     "created_by": {
9       "type": "user",
10       "details": {
11         "user_id": "user_id",
12         "org_id": "org_id",
13         "scout_organization_id": "scout_organization_id",
14         "email": {}
15       }
16     },
17     "last_updated_by": {
18       "type": "user",
19       "details": {
20         "user_id": "user_id",
21         "org_id": "org_id",
22         "scout_organization_id": "scout_organization_id",
23         "email": {}
24       }
25     },
26     "revision_id": "revision_id",
27     "job_id": "job_id"
28   }
29 }

Path parameters

collection_idstringRequired

document_idstringRequired

table_idstringRequired

Request

This endpoint expects a map from strings to nullable booleans or doubles or integers or strings or lists of any.

booleanRequired

doubleRequired

integerRequired

stringRequired

list of anyRequired

Response

Successful Response

dataobject or null

Update a document by ID.

Path parameters

Headers

Request

Response

Errors