Disable Offer
Details#
This endpoint disables the offer specified by offerId.
URL : /offers/:offerId/disable
Method :
POST
info
This is an action that cannot be reverted by the company. If you're looking for a less serious action, check hide.
Authentication
Auth is required to disable an Offer as an Admin. 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).
adminReason#
Body Parameter
Required
String
Reason for the admin to disable the offer. This should only be used for admins, it's not intended to show to the company or the public.
Request examples#
Example 1 - Valid Request#
Code :
200 OK
- Request
- Response
Example 2 - Missing Admin Reason#
Code :
422 UNPROCESSABLE ENTITY
- Request
- Response
Example 3 - Non-Existing Offer#
Code :
422 UNPROCESSABLE ENTITY
- Request
- Response
Example 4 - Blocked Offer#
Code :
403 FORBIDDEN
- Request
- Response