reservations

Update a reservation

Partially updates a reservation. Omitted fields are left unchanged. Assignees, destinations, booked-by contacts and companies are changed with add/remove arrays.

PATCH

/v1/reservations/{id}

curl --request PATCH \
  --url https://api.beamdynamics.io/v1/reservations/{id} \
  --header 'beam-api-key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assigneeIds": {
    "add": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "remove": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  },
  "bookedByIds": {
    "add": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "remove": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  },
  "companies": {
    "add": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "remove": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ]
  },
  "customFields": {},
  "defaultTimezone": "<string>",
  "description": "<string>",
  "destinationIds": {
    "add": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "destinationComment": "<string>",
    "remove": [
      "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>"
}
'

{
  "company": [
    {
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "createdAt": "<string>",
  "createdById": "<string>",
  "customFields": {},
  "defaultTimezone": "<string>",
  "description": "<string>",
  "endDate": "<string>",
  "id": 123,
  "seqId": 123,
  "startDate": "<string>",
  "status": {
    "category": "open",
    "color": "<string>",
    "description": "<string>",
    "id": "<string>",
    "name": "<string>"
  },
  "statusId": "<string>",
  "studioId": "<string>",
  "title": "<string>",
  "updatedAt": "<string>",
  "url": "<string>"
}

Authorizations

beam-api-keystringheaderrequired

Path Parameters

idintegerrequired

Reservation id

Required range: 0 < x

Body

assigneeIdsobject

Assignees to change, as user ids. add lists user ids to assign, remove lists user ids to unassign

Show child attributes

bookedByIdsobject

Contacts the reservation is booked by, as contact ids. add lists contact ids to attach, remove lists contact ids to detach

Show child attributes

companiesobject

Companies to change. add lists company ids to attach, remove lists company ids to detach

Show child attributes

customFieldsobject

Custom field values to set, keyed by custom field id. An existing value is overwritten (null clears it), and a value is only created when content is non-empty

defaultTimezonestring

IANA timezone name for the reservation, for example America/New_York

descriptionstring | null

Reservation description. Send null to clear it

destinationIdsobject

Destinations to change. add lists destination ids to attach, remove lists destination ids to detach, destinationComment is an optional comment stored with the destinations

Show child attributes

endDatestring

End of the reservation as an ISO 8601 date-time with timezone offset. Must not be before startDate

Minimum string length: 1

startDatestring

Start of the reservation as an ISO 8601 date-time with timezone offset. Must not be after endDate

Minimum string length: 1

statusIdstring

Id of the reservation status to set

titlestring

Reservation title

Minimum string length: 1

Response

The updated reservation

companyobject[]required

Companies linked to the reservation

Show child attributes

createdAtstringrequired

Creation timestamp (ISO 8601)

createdByIdstring | nullrequired

Id of the user who created the reservation

customFieldsobjectrequired

Custom field values of the reservation, keyed by custom field id

defaultTimezonestring | nullrequired

Default IANA timezone of the reservation

descriptionstring | nullrequired

Reservation description

endDatestringrequired

End date and time (ISO 8601)

idintegerrequired

Reservation id

seqIdintegerrequired

Sequential reservation number within the studio

startDatestringrequired

Start date and time (ISO 8601)

statusobjectrequired

Current status of the reservation

Show child attributes

statusIdstringrequired

Id of the reservation status

studioIdstringrequired

Id of the studio that owns the reservation

titlestringrequired

Reservation title

updatedAtstringrequired

Last update timestamp (ISO 8601)

urlstringrequired

Link to the reservation in the Beam web app

Still need help? Ask the team