Update Company Profile

curl -X PATCH "https://api.wordsmith.ai/api/v1/company-profiles/3f9c2b71-8d4e-4a06-b5c3-91e7d0a2f648" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "jurisdictions": ["England & Wales", "Ireland", "Scotland"],
    "is_regulated": true,
    "regulatory_details": "Customs broker authorised by HMRC."
  }'

{
  "id": "3f9c2b71-8d4e-4a06-b5c3-91e7d0a2f648",
  "name": "Northwind Logistics Ltd",
  "address": "12 Harbour Street, Bristol BS1 4RN, United Kingdom",
  "registration_number": "09876543",
  "tax_number": "GB123456789",
  "jurisdictions": ["England & Wales", "Ireland", "Scotland"],
  "industry": ["Logistics", "Freight forwarding"],
  "preferred_signatories": ["Sarah Collins, General Counsel", "Mark Ellis, CFO"],
  "organization_type": "private",
  "ownership": "pe_backed",
  "is_part_of_group": true,
  "is_regulated": true,
  "regulatory_details": "Customs broker authorised by HMRC.",
  "is_gdpr_applicable": true,
  "data_storage_locations": "AWS eu-west-1 (Ireland)",
  "business_description": "Road and sea freight across the UK and Ireland for retail and manufacturing clients.",
  "target_customer_profiles": ["Mid-size retailers", "Manufacturers"],
  "additional_info": "We sign on our own paper where possible."
}

PATCH

api

company-profiles

{profile_id}

curl -X PATCH "https://api.wordsmith.ai/api/v1/company-profiles/3f9c2b71-8d4e-4a06-b5c3-91e7d0a2f648" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "jurisdictions": ["England & Wales", "Ireland", "Scotland"],
    "is_regulated": true,
    "regulatory_details": "Customs broker authorised by HMRC."
  }'

{
  "id": "3f9c2b71-8d4e-4a06-b5c3-91e7d0a2f648",
  "name": "Northwind Logistics Ltd",
  "address": "12 Harbour Street, Bristol BS1 4RN, United Kingdom",
  "registration_number": "09876543",
  "tax_number": "GB123456789",
  "jurisdictions": ["England & Wales", "Ireland", "Scotland"],
  "industry": ["Logistics", "Freight forwarding"],
  "preferred_signatories": ["Sarah Collins, General Counsel", "Mark Ellis, CFO"],
  "organization_type": "private",
  "ownership": "pe_backed",
  "is_part_of_group": true,
  "is_regulated": true,
  "regulatory_details": "Customs broker authorised by HMRC.",
  "is_gdpr_applicable": true,
  "data_storage_locations": "AWS eu-west-1 (Ireland)",
  "business_description": "Road and sea freight across the UK and Ireland for retail and manufacturing clients.",
  "target_customer_profiles": ["Mid-size retailers", "Manufacturers"],
  "additional_info": "We sign on our own paper where possible."
}

Preview. This endpoint is available to organisations in the Wordsmith MCP pilot. Other organisations receive 403 mcp_not_enabled. See the preview overview.

Updates a company profile. Send only the fields you want to change. Fields you leave out keep their current value, and null clears a text or enum field. Fields this API does not show, such as the risk appetite set in Settings, are kept as they are. A list field replaces the stored list. It does not merge. To add a jurisdiction, read the profile with Get Company Profile, append to jurisdictions and send the whole list back. Agents read the profile as context, so a change applies to every agent run that starts after it.

Path parameters

string

required

The profile id, from List Company Profiles.

Authentication

Requires an API key, or an OAuth token with directory:admin. The caller must also be able to edit this profile in Settings: an organisation admin, or someone the profile is shared with as an admin. directory:admin is never granted by default. It only narrows what the person who approved it can already do. Admin changes are not available through the MCP server.

Body parameters

string

The organisation’s legal name. It cannot be empty.

string | null

The registered address.

string | null

The company registration number.

string | null

The VAT or tax number.

string[]

Where the organisation operates, by name, e.g. "England & Wales" or "Ireland". Each value must be a jurisdiction Wordsmith knows. Region headings such as "Crown Dependencies" are rejected: name the jurisdiction inside them.

string[]

The organisation’s industries, as free text.

string[]

The people who usually sign, e.g. "Sarah Collins, General Counsel".

enum | null

public, private, llp, partnership, sole_trader, charity or other.

enum | null

founder_owned, vc_backed, pe_backed, publicly_listed or subsidiary_of_listed_group.

boolean

Whether the organisation belongs to a corporate group.

boolean

Whether a regulator supervises the organisation.

string | null

Which regulators, licences or regimes apply.

Whether the GDPR or UK GDPR applies.

string | null

Where the organisation stores data, as free text.

string | null

What the organisation does, in a few sentences.

string[]

Who the organisation sells to.

string | null

Anything else agents should know about the organisation.

Response

Returns 200 with the whole updated company profile.

curl -X PATCH "https://api.wordsmith.ai/api/v1/company-profiles/3f9c2b71-8d4e-4a06-b5c3-91e7d0a2f648" \
  -H "Authorization: Bearer sk-ws-api1-your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "jurisdictions": ["England & Wales", "Ireland", "Scotland"],
    "is_regulated": true,
    "regulatory_details": "Customs broker authorised by HMRC."
  }'

{
  "id": "3f9c2b71-8d4e-4a06-b5c3-91e7d0a2f648",
  "name": "Northwind Logistics Ltd",
  "address": "12 Harbour Street, Bristol BS1 4RN, United Kingdom",
  "registration_number": "09876543",
  "tax_number": "GB123456789",
  "jurisdictions": ["England & Wales", "Ireland", "Scotland"],
  "industry": ["Logistics", "Freight forwarding"],
  "preferred_signatories": ["Sarah Collins, General Counsel", "Mark Ellis, CFO"],
  "organization_type": "private",
  "ownership": "pe_backed",
  "is_part_of_group": true,
  "is_regulated": true,
  "regulatory_details": "Customs broker authorised by HMRC.",
  "is_gdpr_applicable": true,
  "data_storage_locations": "AWS eu-west-1 (Ireland)",
  "business_description": "Road and sea freight across the UK and Ireland for retail and manufacturing clients.",
  "target_customer_profiles": ["Mid-size retailers", "Manufacturers"],
  "additional_info": "We sign on our own paper where possible."
}

Errors

Status	`error_code`	When
400	`invalid_request_body`	The body is not valid JSON or empty, `name` is empty, a list or boolean field is `null`, a field has the wrong type, or an enum value is not one of those listed.
400	`bad_request`	A `jurisdictions` value is unknown or is a region heading. The message names it.
403	`insufficient_scope`	The OAuth token does not hold `directory:admin`.
403	`forbidden`	The caller can read the profile but cannot edit it.
404	`resource_not_found`	No company profile in your organisation has this id, or the caller cannot read it.

Preview

Agents, playbooks and blueprints

Sessions

Playbook authoring

Drafts

Files

Document actions

Operations

Research

Reports

Reviews

Organisation

Sharing

Usage and value

Repositories and search

Path parameters

Authentication

Body parameters

Response

Errors

​Path parameters

​Authentication

​Body parameters

​Response

​Errors

Path parameters

Authentication

Body parameters

Response

Errors