overrideBookingStatus

Mutation

Override the status on a booking.

With a few exceptions, an override can be used to move a booking from any status to any other status. An override can be used to move a booking from a status with a space, to a status without. However, an override cannot be used to move a booking from a status without a space, to a status with a space. A space must be assigned with the assignBookingSpace call first.

When overriding a status, all fields can be considered optional.

Permission Required

This operation requires the BookingStatusOverride permission.

Signature

mutation {
  overrideBookingStatus(
    organisationId: UUID!
    bookingId: ID!
    statusId: UUID
    fields: [FieldDataInput!]
    formSubmissions: [FormSubmissionInput!]
    statusReference: BookingStatusEntityRefInput
  ): Void
}

Arguments

Argument	Type	Default	Description
organisationId*	UUID!	—	The ID of the organisation
bookingId*	ID!	—	The ID of the booking
statusId	UUID	—	The ID of the status to be updated to. Can be any status, except status with a space when booking currently does not have a space
fields	[FieldDataInput!]	—	An array of inputs containing new or updated field data
formSubmissions	[FormSubmissionInput!]	—	An array of inputs containing new or updated form submissions
statusReference	BookingStatusEntityRefInput	—	An status reference input containing new or updated field data

Return type

Void (Void)

Example

GraphQL

mutation OverrideBookingStatus($organisationId: UUID!, $bookingId: ID!, $statusId: UUID, $fields: [FieldDataInput!], $formSubmissions: [FormSubmissionInput!], $statusReference: BookingStatusEntityRefInput) {
  overrideBookingStatus(organisationId: $organisationId, bookingId: $bookingId, statusId: $statusId, fields: $fields, formSubmissions: $formSubmissions, statusReference: $statusReference)
}

curl

curl -X POST https://my.mobiledock.com/api/v1/graphql \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "mutation OverrideBookingStatus($organisationId: UUID!, $bookingId: ID!, $statusId: UUID, $fields: [FieldDataInput!], $formSubmissions: [FormSubmissionInput!], $statusReference: BookingStatusEntityRefInput) { overrideBookingStatus(organisationId: $organisationId, bookingId: $bookingId, statusId: $statusId, fields: $fields, formSubmissions: $formSubmissions, statusReference: $statusReference) }",
    "variables": {
          "organisationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "bookingId": "MDB-26-XXXX-XXXX"
    }
  }'

JavaScript

const response = await fetch('https://my.mobiledock.com/api/v1/graphql', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    query: `
      mutation OverrideBookingStatus($organisationId: UUID!, $bookingId: ID!, $statusId: UUID, $fields: [FieldDataInput!], $formSubmissions: [FormSubmissionInput!], $statusReference: BookingStatusEntityRefInput) {
        overrideBookingStatus(organisationId: $organisationId, bookingId: $bookingId, statusId: $statusId, fields: $fields, formSubmissions: $formSubmissions, statusReference: $statusReference)
      }
    `,
    variables: {
          "organisationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "bookingId": "MDB-26-XXXX-XXXX"
    },
  }),
});

const data = await response.json();