Update a collection by ID.

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

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

Path parameters

collection_idstringRequired

Request

This endpoint expects an object.

collection_display_namestringOptionalDefaults to Untitled

collection_img_urlstringOptional

collection_descriptionstringOptional

columnslist of objectsOptional

Response

This endpoint returns an object.

dataobject or null

Path parameters

Headers

Request

Response

Errors