Skip to main content
PATCH
/
v1
/
downloads
/
{id}
Update
curl --request PATCH \
  --url https://{defaultHost}/v1/downloads/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "download": {
    "enabled": false
  }
}
'
{
  "id": "b5d42056-1977-4563-902e-1b640acf558d",
  "object": "download",
  "alt": null,
  "archived": false,
  "archived_at": null,
  "name": null,
  "title": null,
  "url": null,
  "media": "899ddeb5-d003-4dc3-aafa-e86a96aa3841",
  "product": "ce4097a1-f557-4d3b-a2b2-203efeb46d66",
  "variant": null,
  "created_at": 1772112943,
  "updated_at": 1772112943
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
download
object

Response

200 - application/json

Success

​
id
string | null

The UUID of the specific object.

​
object
string

A string describing the object type returned.

​
alt
string | null

The HTML alt attribute for the download.

​
archived
boolean

Whether or not this download is archived.

​
name
string | null

The name of this download which will be visible to customers. This is required if a url is used instead of attaching a Media record.

​
title
string | null

The HTML title attribute for the download.

​
url
string | null

Instead of attaching a Media record a public URL can be set. If set, customers will be directed to this URL.

​
archived_at
integer | null

Time at which the object was archived. Measured in seconds since the Unix epoch.

​
media

Expandable – The associated media ID.

​
product

Expandable – The associated product ID.

​
variant

Expandable – The associated variant ID.

​
created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

​
updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.