companies

Update a company

Partially updates a company. Only the fields sent are changed. Returns the updated company.

PATCH

/v1/companies/{id}

Update a company

curl --request PATCH \
  --url https://api.beamdynamics.io/v1/companies/{id} \
  --header 'beam-api-key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attributes": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "categoryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customFields": {},
  "description": "<string>",
  "name": "<string>",
  "phone": "<string>",
  "website": "<string>"
}
'

{
  "assetCount": 123,
  "attributes": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "category": {
    "color": "<string>",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "contactCount": 123,
  "createdAt": "<string>",
  "customFields": {},
  "description": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "lastActivityAt": "<string>",
  "locationCount": 123,
  "logo": "<string>",
  "name": "<string>",
  "phone": "<string>",
  "reservationCount": 123,
  "reservations": [
    123
  ],
  "studioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ticketCount": 123,
  "updatedAt": "<string>",
  "website": "<string>"
}

Authorizations

beam-api-keystringheaderrequired

Path Parameters

idstringrequired

The id of the company to update.

Body

attributesstring[] | null

Ids of the access attributes assigned to the company, replacing the current set. Send null or an empty array to clear them.

categoryIdstring

The id of the category to assign. The category can be changed but not removed.

customFieldsobject

Custom field values keyed by company custom field definition id (from the studio). Each value is the content to store; send null to clear it. Keys that are not sent are left unchanged.

descriptionstring | null

The company description. Send null to clear it.

namestring

The company name. Cannot be empty.

Minimum string length: 1

phonestring | null

The company phone number. Send null to clear it.

websitestring | null

The company website URL. Send null to clear it.

Response

The updated company

assetCountnumberrequired

attributesstring[]required

categoryobject | nullrequired

Show child attributes

contactCountnumberrequired

createdAtstringrequired

customFieldsobject | nullrequired

descriptionstring | nullrequired

idstringrequired

lastActivityAtstring | nullrequired

locationCountnumberrequired

logostring | nullrequired

namestringrequired

phonestring | nullrequired

reservationCountnumberrequired

reservationsnumber[]required

studioIdstringrequired

ticketCountnumberrequired

updatedAtstringrequired

websitestring | nullrequired

Still need help? Ask the team