Update company

PATCH/v1/crm/companies/{companyID}

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

companyIDstringrequired

Request body

requiredapplication/json

custom_fieldsany

descriptionstring

domainstring

industrystring

metadataany

namestring

sizestring

websitestring

Responses

200OK

created_atstringrequired

custom_fieldsanyrequired

descriptionstring | nullrequired

domainstring | nullrequired

idstringrequired

industrystring | nullrequired

metadataanyrequired

namestringrequired

sizestring | nullrequired

updated_atstringrequired

websitestring | nullrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

404Not Found

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X PATCH "/v1/crm/companies/string" \
  -H "Content-Type: application/json" \
  -d '{
  "custom_fields": "string",
  "description": "string",
  "domain": "string",
  "industry": "string",
  "metadata": "string",
  "name": "string",
  "size": "string",
  "website": "string"
}'

const response = await fetch("/v1/crm/companies/string", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "custom_fields": "string",
  "description": "string",
  "domain": "string",
  "industry": "string",
  "metadata": "string",
  "name": "string",
  "size": "string",
  "website": "string"
})
});

import requests

response = requests.patch(
    "/v1/crm/companies/string",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "custom_fields": "string",
  "description": "string",
  "domain": "string",
  "industry": "string",
  "metadata": "string",
  "name": "string",
  "size": "string",
  "website": "string"
},
)

Response

{
  "created_at": "string",
  "custom_fields": "string",
  "description": "string",
  "domain": "string",
  "id": "string",
  "industry": "string",
  "metadata": "string",
  "name": "string",
  "size": "string",
  "updated_at": "string",
  "website": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}