Create a document in a collection.

Beta

POST

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

POST

/v2/collections/:collection_id/documents

1 from scoutos import DocumentDataInput, Scout
2 
3 client = Scout(
4     api_key="YOUR_API_KEY",
5 )
6 client.documents.create(
7     collection_id="collection_id",
8     request=DocumentDataInput(),
9 )

Try it

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

Authentication

AuthorizationBearer

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

Path parameters

collection_idstringRequired

Request

This endpoint expects an object or a list of objects.

Document Data InputobjectRequired

list of objectsRequired

Response

This endpoint returns an object.

dataobject or list of objects or null

Authentication

Path parameters

Request

Response

Errors