Create a collection.

Beta

POST

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

POST

/v2/collections

1 from scoutos import Scout
2 
3 client = Scout(
4     api_key="YOUR_API_KEY",
5 )
6 client.collections.create()

Try it

200Successful

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

Request

This endpoint expects an object.

collection_display_namestringOptionalDefaults to Untitled

collection_img_urlstring or nullOptional

collection_descriptionstring or nullOptional

Response

Successful Response

dataobject or null

Create a collection.

Headers

Request

Response

Errors