Skip to main content
PATCH
/
company-profile
Update the company profile
curl --request PATCH \
  --url https://app.gc.ai/api/external/v1/company-profile \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "dba_name": "<string>",
  "industry": "<string>",
  "size": "<string>",
  "location": "<string>",
  "incorporation_country": "<string>",
  "incorporation_state": "<string>",
  "description": "<string>",
  "revenue": "<string>",
  "legal_matters": "<string>",
  "regulations": "<string>",
  "risk_tolerance": "<string>",
  "additional_info": "<string>",
  "customer_types": [
    "<string>"
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "dba_name": "<string>",
  "industry": "<string>",
  "size": "<string>",
  "location": "<string>",
  "incorporation_country": "<string>",
  "incorporation_state": "<string>",
  "description": "<string>",
  "revenue": "<string>",
  "legal_matters": "<string>",
  "regulations": "<string>",
  "risk_tolerance": "<string>",
  "additional_info": "<string>",
  "customer_types": [
    "<string>"
  ],
  "created_at": "<string>",
  "updated_at": "<string>"
}

Authorizations

Authorization
string
header
required

API key for authentication. Format: gcai_xxxxxxxxx

Create API keys in the GC AI app under Settings → API.

Body

application/json
name
string

Company name (cannot be cleared)

Minimum string length: 1
dba_name
string | null

Doing-business-as name. Send null to clear.

industry
string | null

Industry sector. Send null to clear.

size
string | null

Company size band. Send null to clear.

location
string | null

Primary office location. Send null to clear.

incorporation_country
string | null

Country of incorporation. Send null to clear.

incorporation_state
string | null

State/province of incorporation. Send null to clear.

description
string | null

Short company description. Send null to clear.

revenue
string | null

Annual revenue band. Send null to clear.

Typical legal matters. Send null to clear.

regulations
string | null

Key regulations. Send null to clear.

risk_tolerance
string | null

Risk tolerance level. Send null to clear.

additional_info
string | null

Free-form additional context. Send null to clear.

customer_types
string[] | null

Types of customers served. Send null or [] to clear.

Response

The updated company profile

id
string<uuid>
required

Unique company profile identifier

name
string
required

Company name

dba_name
string | null
required

Doing-business-as name, or null

industry
string | null
required

Industry sector, or null

size
string | null
required

Company size band (e.g. "51-200"), or null

location
string | null
required

Primary office location, or null

incorporation_country
string | null
required

Country of incorporation, or null

incorporation_state
string | null
required

State/province of incorporation, or null

description
string | null
required

Short company description, or null

revenue
string | null
required

Annual revenue band, or null

Typical legal matters the company handles, or null

regulations
string | null
required

Key regulations the company must comply with, or null

risk_tolerance
string | null
required

Risk tolerance level (e.g. "Low"), or null

additional_info
string | null
required

Free-form additional context for the AI, or null

customer_types
string[] | null
required

Types of customers the company serves, or null

created_at
string | null
required

ISO 8601 creation timestamp

updated_at
string | null
required

ISO 8601 last-update timestamp