Skip to main content
POST
/
products
/
{id}
/
archive
Archive a product
curl --request POST \
  --url https://api.fyatu.com/api/v3.20/products/{id}/archive \
  --header 'Authorization: Bearer <token>'
{ "success": true, "status": 200, "message": "Product archived", "data": null, "meta": { "requestId": "req_a1b2c3d4e5f6a7b8c9d0e1f2", "platform": "Fyatu CaaS", "timestamp": "2026-05-26T11:30:00Z" } }

Documentation Index

Fetch the complete documentation index at: https://docs.fyatu.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Marks a card product as ARCHIVED. An archived product:
  • Cannot be used to issue new cards (POST /cards with this productId returns 422)
  • Does not affect cards already issued under it — existing cards continue to operate normally
  • Can be restored with POST /products/{id}/activate
Use archiving to retire a product configuration without disrupting in-flight cardholders.

​
Path Parameters

ParameterTypeDescription
idstringThe product ID (prefix prd_)

​
Request Body

None — this is a state-transition endpoint with no body required.

​
Example

curl -X POST https://api.fyatu.com/api/v3.20/products/prd_01HXYZ1111ABCDEF0002/archive \
  -H "Authorization: Bearer $FYATU_API_KEY"

​
Success Response (200)

{
  "success": true,
  "status":  200,
  "message": "Product archived",
  "data":    null,
  "meta": {
    "requestId": "req_01HXY123456ABCDEF",
    "platform":  "Fyatu CaaS",
    "timestamp": "2026-05-26T11:30:00Z"
  }
}

​
Error Codes

CodeHTTPCause
PRODUCT_NOT_FOUND404Product does not exist or belongs to another business
ALREADY_ARCHIVED409Product is already in ARCHIVED status
INSUFFICIENT_SCOPE403Key lacks accounts:write scope
INTERNAL_ERROR500Server error

Authorizations

​
Authorization
string
header
required

API key from the FYATU CaaS portal. Pass as Authorization: Bearer <key>.

Path Parameters

​
id
string
required

Product ID (prefix prd_)

Response

Product archived

​
success
boolean
Example:

true

​
status
integer
Example:

200

​
message
string
Example:

"Product archived"

​
data
unknown
​
meta
object