JAjarvi
Companies

Creates or update a company

Changed on

Save a company in Jarvi. It creates the company if it does not exist, updates it if it does.

post/rest/v2/companies

Request

  • Base URL
    https://functions.prod.jarvi.tech/v1/public-api
  • URL
    https://functions.prod.jarvi.tech/v1/public-api/rest/v2/companies
  • Auth
    API key in header X-API-KEY

Request body

namestring

The name of the company

descriptionstring

The description of the company

linkedinUrlstring

The linkedin url of the company

companyIdstring

The id of the company you want to update.

externalIdstring

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

assigneesstring

The assignees of the company

statusIdstring

The status of the company

Example request

{
  "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"
}

Response

The application has been saved

messagestring
taskIdstring
companyIdstring

Example response

{
  "message": "Company saved successfully",
  "taskId": "0b538428-7652-4243-baaf-3867803d7007",
  "companyId": "d730cca9-d8b0-49e7-b2e0-c58c1bb7af9f"
}

Changes

  • 873dd84c25ebRevision changes
    • info

      api operation id upsertCompany was added

    • info

      api tag Companies added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status