Companies

Update a company

Updates the given fields; changes of name, website, city and country are written to the timeline. Role permission: data.write.

patch/companies/{id}

Request

  • Base URL: https://joinways.app/api/v1
  • URL: https://joinways.app/api/v1/companies/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://joinways.app/oauth/authorize, token URL https://joinways.app/api/oauth/token, scopes: mcp.write)

Headers

Idempotency-Keystring

Optional client-generated key (1 to 255 characters, e.g. a UUID v4) that makes the request idempotent for 24 hours: a retry with the same key replays the recorded response (marked Idempotency-Replayed: true) instead of executing the operation again. Same key with another body: 422 idempotency_key_reuse; while the first request runs: 409 idempotency_conflict. See the Idempotency section.

Request body

namestring
websitestring
phonestring
registration_numberstring
siretstring

Alias of registration_number.

vat_numberstring
addressstring
citystring
postal_codestring
statestring
countrystring

Response

The updated company.

idstring uuid
namestring
registration_numberstring nullable

Company registration number (e.g. SIRET).

vat_numberstring nullable

VAT / tax identifier.

websitestring nullable
phonestring nullable
addressstring nullable
citystring nullable
postal_codestring nullable
statestring nullable

State / province / region (US state, Canadian province…).

countrystring nullable
enrichment_statusstring nullable

Automatic enrichment of the company profile.

enrichment_completed_atstring date-time nullable
created_atstring date-time nullable
updated_atstring date-time nullable
account_idstring uuid
notesstring nullable
sourcestring nullable
source_metadataobject nullable
external_idstring nullable
enrichment_dataobject nullable

What the enrichment found (website, size, sector…).

enrichment_errorstring nullable
enrichment_started_atstring date-time nullable

Example response

{
  "name": "Acme",
  "vat_number": "FR12345678901",
  "website": "https://acme.com",
  "city": "Paris",
  "country": "FR"
}

Changes

No recorded changes to this operation across all 1 revision of this API.