---
title: "Update company"
method: PUT
path: "/api/v2/organizations/{orgSlug}/companies/{companyId}"
tags: ["Companies"]
---

# Update company

`PUT /api/v2/organizations/{orgSlug}/companies/{companyId}`

Update company by id 

 Required scopes: `flex.community.companies.update`

## Path parameters

- `companyId` string, required
- `orgSlug` string, required

## Request body

- UpdateCompanyDto
  - `properties` object — An object that contains all custom properties that can be applied to the item.
  - `startDate` string, date-time — The start date of the company.
  - `location` string — The location of the company.
  - `name` string — The name of the company.
  - `description` string — The description of the company.
  - `email` string — The email of the company.
  - `image` string — The logo/image URL of the company.
  - `url` string — The website URL of the company.
  - `address` AddressRequestDto
    - `country` string — The country of the address.
    - `state` string — The state of the address.
    - `city` string — The city of the address.
    - `street` string — The street of the address.
    - `zip` string — The zip of the address.
  - `billingDetails` CompanyBillingDetailsRequestDto
    - `billingName` string — The billing name of the company that will appear on transactions and invoices.
    - `date` number — Day of month (1–31) for the billing cycle.
    - `shouldSendOverdueReminders` boolean — Whether overdue invoice reminders should be sent for this company.
    - `vatNumber` string — The VAT number of the company.
    - `registrationNumber` string — The registration number of the company.
    - `paymentMethod` string — The payment method of the company.
    - `billingAddress` AddressRequestDto
      - `country` string — The country of the address.
      - `state` string — The state of the address.
      - `city` string — The city of the address.
      - `street` string — The street of the address.
      - `zip` string — The zip of the address.
  - `portalPrivacy` PortalPrivacyRequestDto
    - `isVisible` boolean — Determines whether the member's profile is visible in the members portal.
    - `showContactDetails` boolean — Determines whether the member's contact details are visible in the members portal.
    - `showSocialProfiles` boolean — Determines whether the member's (Twitter, LinkedIn, Facebook, Instragram) socials are visible in the members portal.
  - `hasActiveMembersAllowance` boolean — Indicates whether the "Active members allowance" setting is enabled.
  - `activeMembersAllowanceLimit` number — The limit of active member seats that can be added to the company.

## Response `200`

- CompanyResultDto
  - `properties` object — An object that contains all custom properties that can be applied to the item.
  - `_id` string — The id of the company.
  - `startDate` string, date-time — The start date of the company.
  - `location` string — The location of the company.
  - `name` string — The name of the company.
  - `description` string — The description of the company.
  - `email` string — The email of the company.
  - `image` string — The logo/image URL of the company.
  - `url` string — The website URL of the company.
  - `address` AddressResultDto
    - `country` string — The country of the address.
    - `state` string — The state of the address.
    - `city` string — The city of the address.
    - `street` string — The street of the address.
    - `zip` string — The zip of the address.
  - `status` 'active' | 'former' | 'pending' | 'inactive' | 'not_approved' | 'drop-in' | 'lead' — The status of the company.
  - `billingDetails` CompanyBillingDetailsResultDto
    - `billingName` string — The billing name of the company that will appear on transactions and invoices.
    - `date` number — Day of month (1–31) for the billing cycle.
    - `vatNumber` string — The VAT number of the company.
    - `registrationNumber` string — The registration number of the company.
    - `paymentMethod` string — The payment method of the company.
    - `taxRate` string — A reference to the tax rate that will be applied to the company.
    - `shouldSendOverdueReminders` boolean — Whether overdue invoice reminders should be sent for this company.
    - `billingAddress` AddressResultDto
      - `country` string — The country of the address.
      - `state` string — The state of the address.
      - `city` string — The city of the address.
      - `street` string — The street of the address.
      - `zip` string — The zip of the address.
  - `portalPrivacy` PortalPrivacyResultDto
    - `isVisible` boolean — Determines whether the member's profile is visible in the members portal.
    - `showContactDetails` boolean — Determines whether the member's contact details are visible in the members portal.
    - `showSocialProfiles` boolean — Determines whether the member's (Twitter, LinkedIn, Facebook, Instragram) socials are visible in the members portal.
  - `hasActiveMembersAllowance` boolean — Indicates whether the "Active members allowance" setting is enabled.
  - `activeMembersAllowanceLimit` number — The limit of active member seats that can be added to the company.
  - `tags` string[] — An array of tags associated with the company.
  - `createdAt` string, date-time — The date of creation of the company.
  - `createdBy` string — The user that created the company.
  - `modifiedAt` string, date-time — The date of the last update the company.
  - `modifiedBy` string — The user that last updated the company.

---

[API](https://skmtc.net/officernd/apis/authentication-api.md) · [All operations](https://skmtc.net/officernd/apis/authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/officernd/authentication-api/versions/6bcd33dc648e/schema)