Update a collection by ID.

Beta

PUT

Path parameters

collection_idstringRequired

Request

This endpoint expects an object.

collection_display_namestringOptionalDefaults to Untitled

collection_img_urlstringOptional

collection_descriptionstringOptional

Response

Successful Response

dataobjectOptional

PUT

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

200Updated

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     },
8     "last_updated_at": "2024-01-15T09:30:00Z",
9     "created_at": "2024-01-15T09:30:00Z",
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           "key": "value"
18         }
19       }
20     },
21     "last_updated_by": {
22       "type": "user",
23       "details": {
24         "user_id": "user_id",
25         "org_id": "org_id",
26         "scout_organization_id": "scout_organization_id",
27         "email": {
28           "key": "value"
29         }
30       }
31     },
32     "collection_id": "collection_id",
33     "revision_id": "revision_id"
34   }
35 }

Built with

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

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	},
8	"last_updated_at": "2024-01-15T09:30:00Z",
9	"created_at": "2024-01-15T09:30:00Z",
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	"key": "value"
18	}
19	}
20	},
21	"last_updated_by": {
22	"type": "user",
23	"details": {
24	"user_id": "user_id",
25	"org_id": "org_id",
26	"scout_organization_id": "scout_organization_id",
27	"email": {
28	"key": "value"
29	}
30	}
31	},
32	"collection_id": "collection_id",
33	"revision_id": "revision_id"
34	}
35	}