Skip to main content
PATCH
/
v1
/
companies
/
{id}
Update company
curl --request PATCH \
  --url https://api.stardex.ai/v1/companies/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "domain": "<string>",
  "linkedin_url": "<string>",
  "description": "<string>",
  "location": "<string>",
  "phone": "<string>",
  "is_client": true,
  "custom_fields": [
    {
      "attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "value": "<string>",
      "add_values": [
        "<string>"
      ],
      "remove_values": [
        "<string>"
      ],
      "add_team_member_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "remove_team_member_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "clear_all": true
    }
  ]
}
'
{
  "success": true,
  "data": {
    "message": "Company updated successfully"
  }
}

Authorizations

Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Path Parameters

id
string
required

Company ID

Body

application/json
name
string

Company name.

domain
string

Website domain.

linkedin_url
string

LinkedIn company page URL.

description
string

Company description.

location
string

Company headquarters location.

phone
string

Company phone number.

is_client
boolean

Whether to mark the company as a client.

custom_fields
object[]

Custom field values to update. Get attribute definitions from GET /v1/custom-fields/companies.

Response

Company updated

success
enum<boolean>
required
Available options:
true
data
object
required