Sign in

v1

latestOpenAPI 3.0.02026-07-24161215397.4 KB
Companies

Update company

Update company by id

Required scopes: flex.community.companies.update

put/api/v2/organizations/{orgSlug}/companies/{companyId}

Path parameters

companyIdstring required

company id

orgSlugstring required

organization slug

Request body

propertiesobject

An object that contains all custom properties that can be applied to the item.

startDatestring date-time

The start date of the company.

locationstring

The location of the company.

namestring

The name of the company.

descriptionstring

The description of the company.

emailstring

The email of the company.

imagestring

The logo/image URL of the company.

urlstring

The website URL of the company.

hasActiveMembersAllowanceboolean

Indicates whether the "Active members allowance" setting is enabled.

activeMembersAllowanceLimitnumber

The limit of active member seats that can be added to the company.

Example request

{
  "properties": {
    "customProperty1": "value1",
    "customProperty2": "value2"
  },
  "startDate": "2025-02-25T00:00:00.000Z",
  "location": "603dfbc260f4054084125d33",
  "name": "My New Company",
  "description": "This is an updated description.",
  "email": "example@gmail.com",
  "image": "image-url.com",
  "url": "company-url.com",
  "address": {
    "country": "United States",
    "state": "California",
    "city": "San Francisco",
    "street": "123 Main St",
    "zip": "94105"
  },
  "billingDetails": {
    "billingName": "OfficeRnD",
    "date": 15,
    "shouldSendOverdueReminders": true,
    "vatNumber": "1234",
    "registrationNumber": "4321",
    "paymentMethod": "Cash",
    "billingAddress": {
      "country": "United States",
      "state": "California",
      "city": "San Francisco",
      "street": "123 Main St",
      "zip": "94105"
    }
  },
  "portalPrivacy": {
    "isVisible": true,
    "showContactDetails": true,
    "showSocialProfiles": true
  },
  "hasActiveMembersAllowance": true,
  "activeMembersAllowanceLimit": 10
}

Response

propertiesobject

An object that contains all custom properties that can be applied to the item.

_idstring

The id of the company.

startDatestring date-time

The start date of the company.

locationstring

The location of the company.

namestring

The name of the company.

descriptionstring

The description of the company.

emailstring

The email of the company.

imagestring

The logo/image URL of the company.

urlstring

The website URL of the company.

status'active' | 'former' | 'pending' | 'inactive' | 'not_approved' | 'drop-in' | 'lead'

The status of the company.

hasActiveMembersAllowanceboolean

Indicates whether the "Active members allowance" setting is enabled.

activeMembersAllowanceLimitnumber

The limit of active member seats that can be added to the company.

tagsstring[]

An array of tags associated with the company.

createdAtstring date-time

The date of creation of the company.

createdBystring

The user that created the company.

modifiedAtstring date-time

The date of the last update the company.

modifiedBystring

The user that last updated the company.

Example response

{
  "properties": {
    "customProperty1": "value1",
    "customProperty2": "value2"
  },
  "_id": "603dfbc260f4054084125d33",
  "startDate": "2025-02-25T00:00:00.000Z",
  "location": "603dfbc260f4054084125d33",
  "name": "My Company",
  "description": "This is the description of the company.",
  "email": "example@gmail.com",
  "image": "image-url.com",
  "url": "company-url.com",
  "address": {
    "country": "United States",
    "state": "California",
    "city": "San Francisco",
    "street": "123 Main St",
    "zip": "94105"
  },
  "billingDetails": {
    "billingName": "OfficeRnD",
    "date": 15,
    "vatNumber": "1234",
    "registrationNumber": "4321",
    "paymentMethod": "Cash",
    "taxRate": "6780f1ba1e2f3a4b5c6d7e8f",
    "shouldSendOverdueReminders": true,
    "billingAddress": {
      "country": "United States",
      "state": "California",
      "city": "San Francisco",
      "street": "123 Main St",
      "zip": "94105"
    }
  },
  "portalPrivacy": {
    "isVisible": true,
    "showContactDetails": true,
    "showSocialProfiles": true
  },
  "hasActiveMembersAllowance": true,
  "activeMembersAllowanceLimit": 10,
  "tags": [
    "tag1",
    "tag2",
    "tag3"
  ],
  "createdAt": "2025-02-25T00:00:00.000Z",
  "createdBy": "603dfbc260f4054084125d33",
  "modifiedAt": "2025-02-25T00:00:00.000Z",
  "modifiedBy": "603dfbc260f4054084125d33"
}