Update a collection by ID.

Beta

PUT

https://api.scoutos.com/v2/collections/:collection_id

PUT

/v2/collections/:collection_id

1 curl -X PUT https://api.scoutos.com/v2/collections/collection_id \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{}'

1 {
2   "data": {
3     "collection_config": {
4       "collection_display_name": "Spring Art Collection",
5       "collection_img_url": "https://example.com/images/spring-art-collection.jpg",
6       "collection_description": "A curated collection of vibrant spring-themed artworks from emerging artists.",
7       "tags": [
8         "art",
9         "spring",
10         "vibrant",
11         "emerging artists"
12       ]
13     },
14     "last_updated_at": "2024-01-15T09:30:00Z",
15     "created_at": "2024-01-15T09:30:00Z",
16     "created_by": {
17       "type": "user",
18       "details": {
19         "api_key": {}
20       }
21     },
22     "last_updated_by": {
23       "type": "user",
24       "details": {
25         "api_key": {}
26       }
27     },
28     "collection_id": "col_9876543210",
29     "revision_id": "rev_20240115093000"
30   }
31 }

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.

collection_display_namestring or nullOptional

collection_img_urlstring or nullOptional

collection_descriptionstring or nullOptional

tagslist of strings or nullOptional

table_orderlist of strings or nullOptional

Response

Successful Response

dataobject or null

Authentication

Path parameters

Request

Response

Errors