PATCH
/
companies
/
{companyId}
curl --request PATCH \
  --url https://api.klipycrm.com/api/v1/companies/{companyId} \
  --header 'Content-Type: application/json' \
  --header 'X-KLIPY-API-KEY: <api-key>' \
  --data '{
  "domain": "example.com",
  "description": "A software company specializing in AI solutions",
  "name": "Example Corp",
  "altIndustries": [
    "Software",
    "AI"
  ],
  "tags": [
    "enterprise",
    "b2b"
  ],
  "foundedYear": 2010,
  "address": "123 Main St",
  "city": "San Francisco",
  "state": "CA",
  "country": "USA",
  "linkedin": "company/example-corp",
  "twitter": "examplecorp",
  "facebook": "examplecorp",
  "instagram": "examplecorp",
  "crunchbase": "organization/example-corp",
  "phone": "+1234567890",
  "remarks": "Potential enterprise client"
}'
{
  "success": true,
  "data": {
    "id": "<string>"
  }
}

Authorizations

​
X-KLIPY-API-KEY
string
header
required

Path Parameters

​
companyId
string
required

Unique ID of the company record

Body

application/json
Update an existent company record in the team
​
domain
string

Domain of the company (changing this will affect future auto-detection of people records based on email domain)

Example:

"example.com"

​
description
string | null

Description of the company

Example:

"A software company specializing in AI solutions"

​
name
string | null

Name of the company

Example:

"Example Corp"

​
altIndustries
string[] | null

Alternative industries

Example:
["Software", "AI"]
​
tags
string[] | null

Tags associated with the company

Example:
["enterprise", "b2b"]
​
foundedYear
integer | null

Year the company was founded

Example:

2010

​
address
string | null

Street address of the company

Example:

"123 Main St"

​
city
string | null

City where the company is located

Example:

"San Francisco"

​
state
string | null

State where the company is located

Example:

"CA"

​
country
string | null

Country where the company is located

Example:

"USA"

​
linkedin
string | null

LinkedIn profile without the https://linkedin.com/ prefix

Example:

"company/example-corp"

​
twitter
string | null

Twitter handle

Example:

"examplecorp"

​
facebook
string | null

Facebook profile without the https://facebook.com/ prefix

Example:

"examplecorp"

​
instagram
string | null

Instagram handle

Example:

"examplecorp"

​
crunchbase
string | null

Crunchbase profile without the https://www.crunchbase.com/ prefix

Example:

"organization/example-corp"

​
phone
string | null

Company phone number

Example:

"+1234567890"

​
remarks
string | null

Additional notes or remarks

Example:

"Potential enterprise client"

Response

200
application/json
Success
​
success
boolean
​
data
object