Skip to main content

Deactivate Brand

POST 

/v1/brands/:id/deactivate

Deactivate the selected brand and return its updated record. Subsequent reads and assignments can treat inactive brands differently, so check its state after the write.

Requires brands.write.

Request and response fields at a glance
  • Path parameters: id (integer, required).
  • 201 response (application/json): id (number), name (string, required), nameAR (string), logoUrl (string), storefrontUrl (string), contactEmail (string), contactPhone (string), organizationId (number), isActive (boolean), isVerified (boolean), isSellingToRetail (boolean), totalRevenue (number), totalUnitsSold (number), orderCount (number), createdAt (string, required), updatedAt (string, required), saleChannelAccounts (array), organization (object).

Request​