DocsAPICompanies

Update company

Updates a company profile. Only the fields present in the payload are changed; send null to clear one.

PATCH
/companies/{id}
Path

Company ID

Example: 1

Body

Example: Acme Inc

Example: USD

Example: company

Example: Acme Corporation Ltd

Example: acme.com

Example: Innovating the future

Example: A leading provider of innovative solutions

Example: United States

Example: San Francisco

Example: 123 Main St, San Francisco, CA 94105

Example: SaaS

Example: 2020-01-15

Example: Jane Doe

Example: John Smith

Example: 3

Example: Board member

Example: 4

Example: Observer

Example: ["fintech","b2b"]

Request Body

application/jsonOptional
namestring

Display name of the company

Minimum length: 1
company_currencystring

ISO 4217 currency the company reports in

Minimum length: 3Maximum length: 3
typestring

company for an operating company, fund for a fund the account holds a stake in

Value in: "company" | "fund"
legal_namestring

Registered legal name

domainstring

Website domain, without scheme or www

taglinestring

One-line description

descriptionstring

Longer description

countrystring

Headquarters country

citystring

Headquarters city

addressstring

Registered address

segmentstring

Business segment

founded_onstring

Date the company was founded

ceostring

Name of the current CEO

chairmanstring

Name of the chairman

investment_managerstring

User ID of the investment manager responsible for the company

Pattern: "^\\d+$"
board_positionstring

The investment manager's seat on the board

deputystring

User ID of the deputy

Pattern: "^\\d+$"
deputy_board_positionstring

The deputy's seat on the board

tagsarray<string>

Tags for categorisation (replaces the existing tags)

fieldsobject

Custom fields

Path Parameters

idRequiredstring

Company ID

Pattern: "^\\d+$"

Credentials

Bearer
curl -X PATCH "https://api.fundra.com/v1/companies/1" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Inc",
    "company_currency": "USD",
    "type": "company",
    "legal_name": "Acme Corporation Ltd",
    "domain": "acme.com",
    "tagline": "Innovating the future",
    "description": "A leading provider of innovative solutions",
    "country": "United States",
    "city": "San Francisco",
    "address": "123 Main St, San Francisco, CA 94105",
    "segment": "SaaS",
    "founded_on": "2020-01-15",
    "ceo": "Jane Doe",
    "chairman": "John Smith",
    "investment_manager": "3",
    "board_position": "Board member",
    "deputy": "4",
    "deputy_board_position": "Observer",
    "tags": [
      "fintech",
      "b2b"
    ],
    "fields": {
      "property1": null,
      "property2": null
    }
  }'

Company updated

{
  "id": "1",
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Acme Inc",
  "legal_name": "Acme Corporation Ltd",
  "tagline": "Redefining payments",
  "description": "A leading provider of innovative solutions",
  "domain": "acme.com",
  "logo_url": "https://example.com/logo.png",
  "country": "United States",
  "incorporation_country": "United States",
  "city": "San Francisco",
  "currency": "USD",
  "segment": "SaaS",
  "tags": [
    "fintech",
    "b2b"
  ],
  "founded_on": "2020-01-15",
  "address": "123 Main St, San Francisco, CA 94105",
  "investment_manager": {
    "id": "1",
    "name": "John Doe",
    "avatar_url": "https://example.com/avatar.png"
  },
  "board_position": "Chairman",
  "deputy": {
    "id": "2",
    "name": "Jane Smith",
    "avatar_url": "https://example.com/avatar2.png"
  },
  "deputy_board_position": "Vice Chairman",
  "fields": {
    "sector": "Technology",
    "stage": "Growth"
  },
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-06-20T14:45:00Z"
}

Previous

Add companyPOST

Next

Delete companyDELETE