Unblock Company

Details

This endpoint unblocks the company specified by companyId. Also enables all the company's offers previously disabled with the same adminReason.

URL : /company/:companyId/unblock

Method :

PUT

Authentication

Auth is required to unblock a Company 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).

Request examples

Example 1 - Valid Request (Logged-in as Admin)

Code :

200 OK

Request

/company/431859ea531e53a45a443de0/unblock

Response

{

"_id": "431859ea531e53a45a443de0",

"name": "Unblocked Company",

"contacts": [

"unblocked@company.com"

],

"hasFinishedRegistration": true,

"isBlocked": false,

"isDisabled": false,

"__v": 0,

"bio": "We were unblocked after we broke the rules",

"logo": "https://res.cloudinary.com/unblocked.jpg"

}

Example 2 - Logged-in as a Company

Code :

401 UNAUTHORIZED

Request

/company/431859ea531e53a45a443de0/unblock

Response

{

"error_code": 3,

"errors": [

{

"msg": "insufficient-permissions"

}

],

"or": [

{

"error_code": 3,

"errors": [

{

"msg": "must-be-god"

}

]

},

{

"error_code": 3,

"errors": [

{

"msg": "must-be-admin"

}

]

}

]

}

Example 3 - Non-Existing Company

Code :

422 UNPROCESSABLE ENTITY

Request

/company/62601cb7cb39d3001b3664d9/unblock

Response

{

"error_code": 1,

"errors": [

{

"value": "62601cb7cb39d3001b3664d9",

"msg": "no-company-found-with-id:62601cb7cb39d3001b3664d9",

"param": "companyId",

"location": "params"

}

]

}