Content Management API > Upload Collection

Update a upload collection

Body parameters

type string Required

Must be exactly "upload_collection". JSON API type field

attributes.label string Optional

The label of the upload collection

Example:

"Posts"

attributes.position integer Optional

Ordering index

Example:

relationships.parent.data Optional

Parent upload collection

Type: null, ResourceLinkage<"upload_collection">

relationships.children.data Optional

Underlying upload collections

Type: Array<ResourceLinkage<"upload_collection">>

Returns

Returns a resource object of type upload_collection.

Examples

1
PUT https://site-api.datocms.com/upload-collections/:upload_collection_id HTTP/1.1
2
Authorization: Bearer YOUR-API-TOKEN
3
Accept: application/json
4
X-Api-Version: 3
5
Content-Type: application/vnd.api+json
6

7
{
8
  "data": {
9
    "type": "upload_collection",
10
    "id": "uinr2zfqQLeCo_1O0-ao-Q"
11
  }
12
}

1
curl -g 'https://site-api.datocms.com/upload-collections/:upload_collection_id' \
2
  -X PUT \
3
  -H "Authorization: Bearer YOUR-API-TOKEN" \
4
  -H "Accept: application/json" \
5
  -H "X-Api-Version: 3" \
6
  -H "Content-Type: application/vnd.api+json" \
7
  --data-binary '{"data":{"type":"upload_collection","id":"uinr2zfqQLeCo_1O0-ao-Q"}}'

1
await fetch(
2
  "https://site-api.datocms.com/upload-collections/:upload_collection_id",
3
  {
4
    method: "PUT",
5
    headers: {
6
      Authorization: "Bearer YOUR-API-TOKEN",
7
      Accept: "application/json",
8
      "X-Api-Version": "3",
9
      "Content-Type": "application/vnd.api+json",
10
    },
11
    body: JSON.stringify({
12
      data: { type: "upload_collection", id: "uinr2zfqQLeCo_1O0-ao-Q" },
13
    }),
14
  },
15
);

1
HTTP/1.1 200 OK
2
Content-Type: application/json
3
Cache-Control: cache-control: max-age=0, private, must-revalidate
4
X-RateLimit-Limit: 30
5
X-RateLimit-Remaining: 28
6

7
{
8
  "data": {
9
    "type": "upload_collection",
10
    "id": "uinr2zfqQLeCo_1O0-ao-Q",
11
    "relationships": {
12
      "parent": {
13
        "data": null
14
      },
15
      "children": {
16
        "data": [
17
          {
18
            "type": "upload_collection",
19
            "id": "uinr2zfqQLeCo_1O0-ao-Q"
20
          }
21
        ]
22
      }
23
    },
24
    "attributes": {
25
      "label": "Posts",
26
      "position": 1
27
    }
28
  }
29
}

Did this doc help you?

Need help?

Explore our forum, contact support, or connect with our sales team . You can also chat live with other users in our Slack channel.