Create a collection.

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

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

Request

This endpoint expects an object.

collection_display_namestringOptionalDefaults to Untitled

collection_img_urlstring or nullOptional

collection_descriptionstring or nullOptional

tagslist of stringsOptional

Response

Successful Response

dataobject or null

Headers

Request

Response

Errors