Sign in
companies

Update One company

patch/companies/{id}

Request

  • Base URL: https://twenty.mardu.systems/rest
  • URL: https://twenty.mardu.systems/rest/companies/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Object id.

Query parameters

depth0 | 1

Determines the level of nested related objects to include in the response. - 0: Primary object only - 1: Primary object + direct relations

Request body

namestring

The company name

employeesinteger

Number of employees in the company

idealCustomerProfileboolean

Ideal Customer Profile: Indicates whether the company is the most suitable and valuable customer for you

positionnumber

Company record position

accountOwnerIdstring uuid

Example request

{
  "name": "Company name",
  "domainName": {
    "primaryLinkLabel": "",
    "primaryLinkUrl": "https://greedy-disappointment.com/",
    "secondaryLinks": []
  },
  "linkedinLink": {
    "primaryLinkLabel": "",
    "primaryLinkUrl": "https://pleasant-conversation.com/",
    "secondaryLinks": []
  },
  "xLink": {
    "primaryLinkLabel": "",
    "primaryLinkUrl": "https://adolescent-simple.biz/",
    "secondaryLinks": []
  },
  "annualRecurringRevenue": {
    "amountMicros": "138000000",
    "currencyCode": "EUR"
  }
}

Response

Successful operation

Changes

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