Skip to content
Figur

Archive an asset you own

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

Hide one of your assets — a model or background you did not want.

Only assets your client owns. Figur’s shared library is readable by everyone and archivable by nobody, so a shared asset answers 404 here.

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”

200

Section titled “200”

Successful Response

Media typeapplication/json
AssetLifecycleResponse

The outcome of archiving or restoring one asset.

Three fields on purpose. A client asking to hide an asset needs to know that it is hidden and which library tab it came from — not the row’s owner columns, provenance metadata, or storage key.

object
public_id
required
Public Id
string
status
required
Status

active | archived — the status after the change.

string
kind
required
Kind

The asset’s kind, so you can route it back to the right library view.

string
Examplegenerated
{
  "public_id": "example",
  "status": "example",
  "kind": "example"
}

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"
    }
  ]
}