Sividocs

Set Default Brand

Set an existing brand as the default brand for the authenticated workspace. The default brand is used when generating designs without specifying a brand.

Endpoint

POST brand/set-default

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 set as default
abstractUserIdStringNoUnique identifier for the user (Enterprise/Super API only)

Response

Success Response (200 OK)

{
  "status": 200,
  "body": {
    "message": "Default brand updated 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
  • Only one brand can be the default at a time
  • Setting a new default brand does not archive the previous default