companies

Create a company

Creates a company in the studio. The name and a company category are required. Returns the created company.

POST

/v1/companies

Create a company

curl --request POST \
  --url https://api.beamdynamics.io/v1/companies \
  --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

Body

attributesstring[] | null

Ids of the access attributes to assign to the company. Omit, send null or send an empty array for none.

categoryIdstringrequired

The id of the category to assign. Required, and must be a company category in the studio.

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.

namestringrequired

The company name. Required and 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 created 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