Skip to content
Figur

Archive a Background you own

POST
/v1/backgrounds/{public_id}/archive
curl --request POST \
  --url https://example.com/v1/backgrounds/example/archive \
  --header 'Authorization: Bearer <token>'

Retire one of your own scenes.

204 for the same reason the Shot archive gives: your read surface lists only published Backgrounds, so there is nothing truthful to return for one that has just left that set. Publishing stays an operator action.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
public_id
required
Public Id
string

Header Parameters

Section titled “Header Parameters”
X-Shopify-Hmac-Sha256
Any of:
string

Responses

Section titled “Responses”

204

Section titled “204”

Successful Response

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}