patch https://{subdomain}.workable.com/spi/v3/requisitions//reject
Rejects a requisition (must be in a compatible state). Required scope: w_requisitions. For accounts with Hiring Plan.
Results
Calling the /requisitions/:code endpoint will return the full requisition JSON object.
The object will have the following keys:
| key | type | description |
|---|---|---|
| id | string | The requisition identifier |
| code | string | The code of the requisition |
| job | object | The job of the requisition |
| job.id | string | The ID of the job |
| job.title | string | The title of the job |
| department | object | The department of the requisition |
| department.id | string | The ID of the department |
| department.name | string | The name of the department |
| location | object | The location of the requisition |
| location.location_str | string | The string representation of the location |
| location.country | string | The country full name |
| location.country_code | string | The 2-letter ISO code of the country |
| location.region | string | The region of the location |
| location.region_code | string | The code of the region of the location |
| location.city | string | The city of the location |
| location.zip_code | string | The ZIP code of the location |
| requester | object | The requester of the requisition |
| requester.id | string | The ID of the requester |
| requester.name | string | The name of the requester |
| hiring_manager | object | The hiring manager of the requisition |
| hiring_manager.id | string | The ID of the hiring manager |
| hiring_manager.name | string | The name of the hiring manager |
| owner | object | The owner of the requisition |
| owner.id | string | The ID of the owner |
| owner.name | string | The name of the owner |
| plan_date | string | The plan date of the requisition in YYYY-MM-DD format (ie 2022-01-31) |
| start_date | string | The start date of the requisition in YYYY-MM-DD format (ie 2022-01-31) |
| salary_range | object | The salary range of the requisition. |
| salary_range.from | number | The minimum salary of the requisition |
| salary_range.to | number | The maximum salary of the requisition |
| salary_range.frequency | string | The frequency of the salary range. Can be one of hour, day, week, month, year. |
| salary_range.currency_iso | string | The 3-letter ISO code of the currency (ie EUR, USD). |
| salary | object | The salary of the requisition. Only exists for filled requisitions. |
| salary.amount | number | The amount of the salary |
| salary.frequency | string | The frequency of the salary range. Can be one of hour, day, week, month, year. |
| salary.currency_iso | string | The 3-letter ISO code of the currency (ie EUR, USD). |
| candidate_id | string | |
| employment_type | string | The employment type. Can be one of Full-time, Part-time, Contract, Temporary, Other. |
| reason | string | The reason for the requisition. Can be one of new_hire, replacement, backfill. |
| state | string | The state of the requisition. Can be one of processing, draft, pending, approved, open, filled, rejected, cancelled, reserved, on_hold. |
| requisition_attributes | array | The attributes of the requisition. For the keys of each requisition attribute check the table below. |
| approval_groups | array | The approval groups of the requisition, in the order of the approval workflow. For the keys of each approval group check the table below. |
Each document_variable contains the following keys
| key | type | description |
|---|---|---|
| name | string | The name of the requisition attribute |
| value.body | string, number or boolean | The value of the requisition attribute. It's type varies depending on the type of the requisition attribute:string if the type is of case short text, free text or datenumber if the type is numericboolean if the type is boolean |
| value.choices | array | Array of the labels of the selected choices |
| data | object | The value data (only for salary requisition attributes) |
| data.amount | number | The amount of salary |
| data.frequency | string | The frequency of the salary. Can be one of hour, day, week, month, year. |
| data.currency_iso | string | The 3-letter ISO code of the currency (ie EUR, USD). |
Each approval group contains the following keys
| key | type | description |
|---|---|---|
| id | string | The approval group identifier |
| approvers | array | Array of the approvers of the approval group for the specific requisition. For groups with a decision (positive or negative), only that approver will be present. For groups without a decision, all the approvers will appear. |
| approvers.id | string | The identifier of the approver |
| approvers.name | string | The name of the approver |
| approvers.decision | string | The decision of the approver (only if the approver has submitted a decision). If present, it is one of approved, rejected. |