Edit Offer
Details#
This endpoint is used to edit offers. Both Admins and Companies can use it.
URL : /offers/edit/:offerId
Method :
Authentication
Auth is required to edit an Offer as a Company or Admin. Otherwise, if in god mode, god_token must be provided.
Concurrent Offers
The time when the offer is published must not make the respective company exceed the maximum number of concurrent active offers.
Parameters#
god_token#
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).
owner#
If the logged-in user is a company, this is not required.
Otherwise, it specifies the company to link this offer to.
title#
The title of the offer, used in search.
publishDate#
The date when the offer will be made public (published).
Must be in the future.
publishEndDate#
The date when the offer will be "hidden" from the application (will be invisible to search).
- Must be after
now(in the future). - Must be after the publishDate, if present.
- Must not exceed 6 months after publishDate.
jobMinDuration#
The duration of the work itself (in months).
- Must be an Integer (positive).
- Is Required if jobMaxDuration is set.
jobMaxDuration#
The duration of the work itself (in months).
- Must be an Integer (positive).
jobStartDate#
The date when the job is expected to begin.
description#
The offer description. Text that is shown when users request info about a specific offer.
contacts#
List of contacts regarding offer information.
isPaid#
Informs if the offer has paid compensation.
vacancies#
Number of vacancies available.
- Must be an Integer (positive)
jobType#
Type of offer.
caution
Must be a valid Job Type (
currently ["FULL-TIME", "PART-TIME", "SUMMER INTERNSHIP", "CURRICULAR INTERNSHIP", "RESEARCH GRANT", "OTHER"]).
fields#
Specifies the fields (areas) the offer corresponds to.
caution
Must be a valid Field Type ( see list).
technologies#
Specifies the technologies the offer is looking for.
caution
Must be a valid Technology Type ( see list).
isHidden#
If true, the offer will not show up in search by default. However, the owner and admins can still see it, by activating
the showHidden flag when searching.
location#
Where the work will be done (usually in City, Country format).
coordinates#
The coordinates of the workplace, so that a map can be shown in the UI.
requirements#
An array of strings containing job requirements in list form. Useful to list them in a more straightforward way.
applyURL#
URL that users can use to apply to the offer. Must use http, https or mailto protocols.
Must respect the following regex: https?://S+.\S+
Request examples#
Example 1 - Valid Request (Logged-in as Company)#
Code :
- Request
- Response
Example 2 - Publish Date in the Past#
Condition : If publishDate is in the past.
Code :
- Request
- Response
Example 3 - Publish time over 6 month limit#
Condition : If publishEndDate is more than 6 months after publishDate.
Code :
- Request
- Response
Example 4 - Maximum number of concurrent offers exceeded#
Condition : If the owner has more than 5 offers active (published and non-hidden) at a same point in time.
Code :
- Request
- Response
Example 5 - Disabled company (Logged-in as Admin)#
Condition : If the owner is disabled.
Code :
- Request
- Response
Example 6 - Offer blocked (With god token)#
Condition : If the offer has been blocked by an Admin.
Code :
- Request
- Response