Update a document by ID.

Beta

PUT

Path parameters

collection_idstringRequired

document_idstringRequired

table_idstringRequired

Request

This endpoint expects a map from strings to booleans or doubles or integers or strings.

{}

map from strings to booleans or doubles or integers or strings

Response

Successful Response

dataobjectOptional

PUT

1 curl -X PUT https://api-prod.scoutos.com/v2/collections/collection_id/tables/table_id/documents/document_id \
2      -H "Authorization: Bearer <apiKey>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "key": true
6 }'

200Updated

1 {
2   "data": {
3     "created_by": {
4       "type": "user",
5       "details": {
6         "user_id": "user_id",
7         "org_id": "org_id",
8         "scout_organization_id": "scout_organization_id",
9         "email": {
10           "key": "value"
11         }
12       }
13     },
14     "last_updated_by": {
15       "type": "user",
16       "details": {
17         "user_id": "user_id",
18         "org_id": "org_id",
19         "scout_organization_id": "scout_organization_id",
20         "email": {
21           "key": "value"
22         }
23       }
24     },
25     "document_id": "document_id",
26     "data": {
27       "key": "value"
28     },
29     "document_data_id": "document_data_id",
30     "created_at": "2024-01-15T09:30:00Z",
31     "last_updated_at": "2024-01-15T09:30:00Z",
32     "revision_id": "revision_id"
33   }
34 }

Built with

1	curl -X PUT https://api-prod.scoutos.com/v2/collections/collection_id/tables/table_id/documents/document_id \
2	-H "Authorization: Bearer <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"key": true
6	}'

1	{
2	"data": {
3	"created_by": {
4	"type": "user",
5	"details": {
6	"user_id": "user_id",
7	"org_id": "org_id",
8	"scout_organization_id": "scout_organization_id",
9	"email": {
10	"key": "value"
11	}
12	}
13	},
14	"last_updated_by": {
15	"type": "user",
16	"details": {
17	"user_id": "user_id",
18	"org_id": "org_id",
19	"scout_organization_id": "scout_organization_id",
20	"email": {
21	"key": "value"
22	}
23	}
24	},
25	"document_id": "document_id",
26	"data": {
27	"key": "value"
28	},
29	"document_data_id": "document_data_id",
30	"created_at": "2024-01-15T09:30:00Z",
31	"last_updated_at": "2024-01-15T09:30:00Z",
32	"revision_id": "revision_id"
33	}
34	}