Skip to main content
POST
/
rest
/
v2
/
projects
Creates or update a project
curl --request POST \
  --url https://functions.prod.jarvi.tech/v1/public-api/rest/v2/projects \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "projectId": "713a8005-e54d-4ee3-b6a4-89b27167dde6",
  "name": "Dev JAVA - IDF",
  "externalId": "123456",
  "isMadeForRecruitment": true,
  "isMadeForSales": true,
  "createdAt": "2024-01-01T00:00:00.000Z",
  "assignees": "Sarah Le Roué, Johan Barri, Quentin DECRE",
  "statusId": "dbab8773-8b59-4597-af75-b31333dd5409",
  "companyId": "df587e25-03e6-4b9a-aaa4-c9c20a913f4d",
  "colorId": "#d81b60",
  "customFieldsValues": {
    "00da911c-e3e1-46c1-86cc-0c1ec53e3213": "<p>Custom field content</p>",
    "de7fae4a-5f73-43a4-a92f-e19c4ecd81f1": "true",
    "8f4e7a2b-c9d1-45e6-b3a2-f8e9c7d6b5a4": "Angular, React, Vue"
  }
}
'
{
  "message": "Project saved successfully",
  "taskId": "0b538428-7652-4243-baaf-3867803d7007",
  "projectId": "d730cca9-d8b0-49e7-b2e0-c58c1bb7af9f"
}
You must use your private api key for this request.
You can completely customize all information for each profile using Custom fields. Click on this link to understand how to read and write information in custom fields.

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
projectId
string

The id of the project you want to update.

Example:

"713a8005-e54d-4ee3-b6a4-89b27167dde6"

​
name
string

The name of the project you want to update/create.

Example:

"Dev JAVA - IDF"

​
externalId
string

The id of the project you want to update in your system.

Example:

"123456"

​
isMadeForRecruitment
boolean

Whether the project is made for recruitment, and should be displayed in the ATS

Example:

true

​
isMadeForSales
boolean

Whether the project is made for sales, and should be displayed in the CRM

Example:

true

​
createdAt
string

The date of creation of the project

Example:

"2024-01-01T00:00:00.000Z"

​
assignees
string

The assignees of the project

Example:

"Sarah Le Roué, Johan Barri, Quentin DECRE"

​
statusId
string

The status of the project

Example:

"dbab8773-8b59-4597-af75-b31333dd5409"

​
companyId
string

The company of the project

Example:

"df587e25-03e6-4b9a-aaa4-c9c20a913f4d"

​
colorId
string

The color of the project

Example:

"#d81b60"

​
customFieldsValues
object

Custom fields values for the project. The key should be the field ID and the value can be any text value.

Example:
{
  "00da911c-e3e1-46c1-86cc-0c1ec53e3213": "<p>Custom field content</p>",
  "de7fae4a-5f73-43a4-a92f-e19c4ecd81f1": "true",
  "8f4e7a2b-c9d1-45e6-b3a2-f8e9c7d6b5a4": "Angular, React, Vue"
}

Response

The application has been saved

​
message
string
Example:

"Project saved successfully"

​
taskId
string
Example:

"0b538428-7652-4243-baaf-3867803d7007"

​
projectId
string
Example:

"d730cca9-d8b0-49e7-b2e0-c58c1bb7af9f"