Disable Company
Details#
This endpoint disables the company specified by companyId. Also hides all the company's offers.
URL : /company/:companyId/disable
Method :
PUT
info
This is an action that can be reverted by the company. If you're looking for a more permanent action, check block.
Authentication
Auth is required as a Company to disable it. Otherwise, if in god mode, god_token must be provided.
Parameters#
god_token#
Body Parameter
Optional
String
If set, will use this for validating the usage of god mode (in case no session details are available, i.e., no logged-in user).
Request examples#
Example 1 - Valid Request (Logged-in as Company)#
Code :
200 OK
- Request
- Response
Example 2 - Logged-in as an Admin#
Code :
401 UNAUTHORIZED
- Request
- Response
Example 3 - Non-Existing Company#
Code :
422 UNPROCESSABLE ENTITY
- Request
- Response
Example 4 - Logged-in as a Different Company#
Code :
403 FORBIDDEN
- Request
- Response