updateBookingStatus

Mutation

Update a booking to a following status.

This call is used to progress bookings through a normal flow. The status must be specified as one of the statuses following for the current status, or an exception status. If organisationId is the carrier, the status must be a carrier available status. All required fields must be provided, or must have been provided in earlier calls.

If the organisation specified is the carrier, you need the ParticipateCarrierBookings permission. If the organisation specified is the location, you need the ParticipateLocationBookings permission.

Permission Required

This operation requires the BookingParticipation permission.

Signature

mutation {
  updateBookingStatus(
    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 update to. Must be a subsequent status to the current status or an exception status
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	—	A status reference input containing new or updated field data

Return type

Void (Void)

Example

GraphQL

mutation UpdateBookingStatus($organisationId: UUID!, $bookingId: ID!, $statusId: UUID, $fields: [FieldDataInput!], $formSubmissions: [FormSubmissionInput!], $statusReference: BookingStatusEntityRefInput) {
  updateBookingStatus(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 UpdateBookingStatus($organisationId: UUID!, $bookingId: ID!, $statusId: UUID, $fields: [FieldDataInput!], $formSubmissions: [FormSubmissionInput!], $statusReference: BookingStatusEntityRefInput) { updateBookingStatus(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 UpdateBookingStatus($organisationId: UUID!, $bookingId: ID!, $statusId: UUID, $fields: [FieldDataInput!], $formSubmissions: [FormSubmissionInput!], $statusReference: BookingStatusEntityRefInput) {
        updateBookingStatus(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();