Skip to main content

Archive Brand

Archive a brand from the authenticated workspace. Archived brands are excluded from Get Brands results by default.

Endpoint​

POST brand/archive

Authentication​

Include your Enterprise API credentials in the request headers:

sivi-api-key: YOUR_API_KEY

Request Body Example​

{
  "bId": "b_s87vFxpfM0R"
}

Request Parameters​

ParameterTypeRequiredDescription
bIdStringYesBrand ID to archive
abstractUserIdStringNoUnique identifier for the user (Enterprise/Super API only)

Response​

Success Response (200 OK)​

{
  "status": 200,
  "body": {
    "message": "Brand archived successfully",
    "bId": "b_s87vFxpfM0R"
  }
}

Error Responses​

Brand Not Found (404 Not Found)​

{
  "status": 404,
  "body": {
    "message": "Brand not found in workspace"
  }
}

Authentication Error (401 Unauthorized)​

{
  "status": 401,
  "body": {
    "message": "Failed to authenticate request. Please add sivi-api-key header in request"
  }
}

Invalid Input (422 Unprocessable Entity)​

{
  "status": 422,
  "body": {
    "message": "Invalid input"
  }
}

Server Error (500 Internal Server Error)​

{
  "status": 500,
  "body": {
    "message": "Server internal error"
  }
}

Usage Notes​

  • The brand must belong to the authenticated workspace
  • Archiving a brand does not delete it permanently; it marks it as archived
  • If the archived brand was the workspace default, you should set a new default brand using Set Default Brand