reservations

Create a reservation

Creates a new reservation in the studio of the authenticated user.

POST

/v1/reservations

curl --request POST \
  --url https://api.beamdynamics.io/v1/reservations \
  --header 'beam-api-key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assigneeIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "bookedByIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "companies": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "customFields": {},
  "description": "<string>",
  "destinationIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "endDate": "2023-11-07T05:31:56Z",
  "startDate": "2023-11-07T05:31:56Z",
  "statusId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>"
}
'

{
  "createdAt": "2023-11-07T05:31:56Z",
  "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "defaultTimezone": "<string>",
  "description": "<string>",
  "endDate": "2023-11-07T05:31:56Z",
  "id": 123,
  "seqId": 123,
  "startDate": "2023-11-07T05:31:56Z",
  "statusId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "studioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

beam-api-keystringheaderrequired

Body

assigneeIdsstring[] | null

User ids to assign to the reservation

bookedByIdsstring[] | null

Contact ids of the people who booked the reservation

companiesstring[] | null

Company ids to relate to the reservation

customFieldsobject

Custom field values to set on the reservation, keyed by custom field id

descriptionstring | null

Free-text description of the reservation

destinationIdsstring[] | null

Location ids used as destinations, with an optional destination comment

endDatestringrequired

End of the reservation as an ISO 8601 timestamp with timezone offset

Minimum string length: 1

startDatestringrequired

Start of the reservation as an ISO 8601 timestamp with timezone offset

Minimum string length: 1

statusIdstring

Id of the reservation status. When omitted, the studio default status is used

titlestringrequired

Title of the reservation

Minimum string length: 1

Response

The created reservation

createdAtstringrequired

Creation timestamp

createdByIdstring | nullrequired

Id of the user who created the reservation

defaultTimezonestring | nullrequired

Default timezone of the reservation

descriptionstring | nullrequired

Description of the reservation

endDatestringrequired

End of the reservation as an ISO 8601 timestamp

idintegerrequired

Reservation id

seqIdintegerrequired

Sequential number of the reservation within the studio

startDatestringrequired

Start of the reservation as an ISO 8601 timestamp

statusIdstringrequired

Id of the reservation status

studioIdstringrequired

Id of the studio owning the reservation

titlestringrequired

Title of the reservation

updatedAtstringrequired

Last update timestamp

Still need help? Ask the team