Sign in
companies

Update Many companies

patch/companies

Request

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

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

filterstring

Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2. For like/ilike, use % as a wildcard (e.g. %value% for substring match). Refer to the filter section at the top of the page for more details.

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.