Skip to main content
POST
/
rest
/
v2
/
companies
Creates or update a company
curl --request POST \
  --url https://functions.prod.jarvi.tech/v1/public-api/rest/v2/companies \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "Jarvi",
  "description": "Jarvi is an ATS and CRM that gather your talents, conversations, opportunities, clients in one place.",
  "linkedinUrl": "https://www.linkedin.com/company/jarvi-tech/",
  "companyId": "713a8005-e54d-4ee3-b6a4-89b27167dde6",
  "externalId": "123456",
  "assignees": "Sarah Le Roué, Johan Barri, Quentin DECRE",
  "statusId": "dbab8773-8b59-4597-af75-b31333dd5409"
}
'
{
  "message": "Company saved successfully",
  "taskId": "0b538428-7652-4243-baaf-3867803d7007",
  "companyId": "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
​
name
string

The name of the company

Example:

"Jarvi"

​
description
string

The description of the company

Example:

"Jarvi is an ATS and CRM that gather your talents, conversations, opportunities, clients in one place."

​
linkedinUrl
string

The linkedin url of the company

Example:

"https://www.linkedin.com/company/jarvi-tech/"

​
companyId
string

The id of the company you want to update.

Example:

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

​
externalId
string

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

Example:

"123456"

​
assignees
string

The assignees of the company

Example:

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

​
statusId
string

The status of the company

Example:

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

Response

The application has been saved

​
message
string
Example:

"Company saved successfully"

​
taskId
string
Example:

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

​
companyId
string
Example:

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