Bookings

This endpoint is used for managing bookings

Get bookings

get

https://api.collinsbookings.com/apihttps://api-playpen.collinsbookings.com/api

/bookings

Returns an array of all bookings which the authenticated user is authorised to view. The response will be paginated.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

actual_guestsstringOptional

Filter by the number of actual_guests. You can filter by a range of actual guests, eg 1-10 for any bookings with an actual_guests between 1 and 10. You can also pass through more than one range, for example, 1-4,10-15 will bring back bookings between 1 to 4 and between 10 to 15.

Example: 1-10

assigned_areastring[]Optional

Filters on bookings that are assigned to the given area ID. If a comma-separated list is passed, bookings assigned to any of the given area IDs will be returned. Alternatively, to filter on whether bookings have an assigned area or not, use true or false.

Example: 5cab10d8f44d3861c8c3819d

assigned_tostring[]Optional

Filters on bookings that are assigned to the given user ID. If a comma-separated list is passed, bookings assigned to any of the given user IDs will be returned. To filter on bookings that are not assigned to a user, use none.

Example: 5cab111386510d011b597b3f

referenceintegerOptional

Filters on bookings that have the given booking reference ID.

Example: 12345

created_datestring · dateOptional

Filters on bookings that were created on the given date.

Example: 2019-01-01

created_date_fromstring · dateOptional

Filters on bookings that were created on or after the given date.

Example: 2019-01-01

created_date_tostring · dateOptional

Filters on bookings that were created on or before the given date

Example: 2019-03-01

current_stagestringOptional

Filters on bookings that have the given current_stage.

Example: Arrived

datestring · dateOptional

Filters on bookings that take place on the given date.

Example: 2019-01-01

date_fromstring · dateOptional

Filters on bookings that take place on or after the given date.

Example: 2019-01-01

date_tostring · dateOptional

Filters on bookings that take place on or before the given date.

Example: 2019-01-01

emailstringOptional

Filters on bookings that have the given email address.

Example: [email protected]

auto_confirmedbooleanOptional

Filters on bookings that were auto-confirmed.

walk_inbooleanOptional

Filters on bookings that were walk-ins.

follow_upstring · dateOptional

Filters on bookings that have a follow up of the given date.

Example: 2019-01-01

follow_up_fromstring · dateOptional

Filters on bookings that have a follow up email scheduled to be sent on or after the given date.

Example: 2019-01-01

follow_up_tostring · dateOptional

Filters on bookings that have a follow up email scheduled to be sent on or before the given date.

Example: 2019-03-01

has_preordersbooleanOptional

Filters on bookings that have preorders.

labelsstring[]Optional

Filters on bookings that have the given labels. If a comma-separated list is passed, bookings which have any of the given labels will be returned.

Example: ["Need to call"]

last_updatedstring · dateOptional

Filters on bookings which were last updated on the given date.

Example: 2019-01-01

last_updated_fromstring · dateOptional

Filters on bookings which were last updated on or after the given date.

Example: 2019-01-01

last_updated_tostring · dateOptional

Filters on bookings which were last updated on or before the given date.

Example: 2019-01-03

notificationsstring[]Optional

Filters on bookings which have the given notification. If a comma-separated list is passed, bookings which have all of the given notifications will be returned.

Example: ["new_messages"]

num_peoplestringOptional

Filters on bookings which have the given number of guests. You can optionally pass through a range, for example 6 TO 10 would filter on bookings containing between 6 and 10 guests.

Example: 10

offerstring[]Optional

Filters on bookings which have the given offer. This filter accepts a single offer ID, or multiple offer IDs separated by a comma to filter on bookings containing any of the given offers. To filter on bookings with no offer, use none.

partner_sourcestringOptional

Filters on bookings which have the given partner_source.

Example: christmas_page

phonestringOptional

Filters on bookings which have the given telephone number.

Example: 01234567890

preorders_statusstring · enumOptional

Filters on bookings which have the given status for preorders.

Example: completePossible values:

private_hirebooleanOptional

Filters on bookings which are private hire.

querystringOptional

Filter on bookings which have a full_name, email, company or phone similar to the search query.

Example: @example.com

start_timestringOptional

Filters on bookings which have the given start time. This filter can also accept a range of times, for example 12:00 TO 15:30 will filter bookings starting between 12pm and 3:30pm.

Example: 13:15

status_changed_datestring · dateOptional

Filters on bookings where the status was changed on the given date.

Example: 2019-01-01

status_changed_date_fromstring · dateOptional

Filters on bookings where the status was changed on or after the given date.

Example: 2019-01-01

status_changed_date_tostring · dateOptional

Filters on bookings where the status was changed on or before the given date.

Example: 2019-03-01

timestringOptional

Filters on bookings that take place between the given time range, taking into account both the start time and the end time of the booking.

Example: 12:00 TO 13:00

typestring[]Optional

Filters on bookings that have the given booking type ID. If a comma-separated list is passed, bookings with any of the given booking type IDs will be returned.

Example: 5cab0bcbfcf59f7fd26bedd9

customer_idstring[]Optional

Filters on bookings that are associated with the given customer ID. If a comma-separated list is passed, bookings associated with any of the given customer IDs will be returned.

Example: 5cab0c245ca3d2d984a4b938

venue_idstring[]Optional

Filters on bookings that are for the given venue ID. If a comma-separated list is passed, bookings for any of the given venue IDs will be returned. To filter bookings with no assigned venue, use none.

Example: 5cab0c7ba7a3f443a918f1b7

waitlistedbooleanOptional

Filters on bookings that have been waitlisted.

zonestringOptional

Filters on bookings that have been assigned to an area in the given zone ID. If a comma-separated list is passed, bookings assigned to an area in any of the given zone IDs will be returned.

Example: 5cab0cd477dd1224215c668a

include_preordersbooleanOptional

Decide whether to include the pre-orders of the bookings in the response. This defaults to false.

limitinteger · min: 1 · max: 30Optional

Limit the response to the specified number of records.

Default: 30Example: 30

sortstring[]Optional

The fields which the results should be sorted by. If this value is not specified, the records will be sorted in order of relevance to the query parameter. If the query parameter is not specified, records will be sorted in order of their created_date. To sort in decending order, prefix the field name with a '-' character.

Example: -last_updated

pagestringOptional

The page number to retrieve results for. Learn more about pagination

Default: 1Example: 2

Responses

200

Bookings were successfully retrieved.

application/json

401

Authorization credentials were required but not found

application/json

403

The request cannot be carried out using the given credentials

404

The requested resource could not be found

application/json

429

The number of requests remaining in the current rate limit window has been exceeded

application/json

get

/bookings

HTTPcURLJavaScriptPython

GET /api/bookings HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "bookings": [
    {
      "id": "5cab15dbff3b7aae0090ad44",
      "assigned_to": "5cab162d8589744d72dbbc2b",
      "created_by": "5cab162d8589744d72dbbc2b",
      "status": "new",
      "status_changed_date": "2019-01-01 13:30:00",
      "follow_up": "2019-01-02 13:13:00",
      "reference": "12345678",
      "venue_id": "5c80155a86bb06bc1401ea1e",
      "venue_group": "5c8015884e68d55f12c7ec9d",
      "assigned_areas": [
        {
          "id": "525588460df6906334ca1ed7",
          "name": "Table 1",
          "zone": "533d59f80df690746c714614"
        }
      ],
      "assigned_area_locked": true,
      "assigned_area_locked_by": "5cab162d8589744d72dbbc2b",
      "num_people": "2",
      "date": "2019-04-08",
      "time": "13:30",
      "duration": "60",
      "type": {
        "id": "5cab175756a18dbcd8156ab1",
        "name": "Brunch",
        "guestlist": true,
        "private_hire": true,
        "value": "60"
      },
      "value": "120.00",
      "customer_id": "5314491e0a8efb6d7c19c39c",
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "additional_emails": [
        "[email protected]"
      ],
      "phone": 1234567890,
      "alternative_phone": 1234567891,
      "company": "The Access Group",
      "company_address": {
        "street": "Penn Street",
        "city": "London",
        "post_code": "N1 5DL"
      },
      "deposits": [
        {
          "id": "5ca1de0628e7ff2356267752",
          "amount": {
            "currency": "GBP",
            "amount": 1000
          },
          "paid_type": "Soda voucher",
          "status": "paid",
          "type": "manual_payment",
          "notes": "Customer called up over the phone to make this payment",
          "payment_ref": "ch_1DTmw4DK5dphsmtEbSLGj6Wt",
          "date": "2019-01-01 13:30:00",
          "refund_ids": [
            "5ca1de0628e7ff2356267753"
          ]
        }
      ],
      "refunds": [
        {
          "id": "5ca1de0628e7ff2356267752",
          "amount": {
            "currency": "GBP",
            "amount": 1000
          },
          "notes": "A guest dropped out so we've refunded them 10%.",
          "created_date": "2019-01-01 13:30:00"
        }
      ],
      "lost": false,
      "actual_guests": 1,
      "current_stage": "arrived_seated",
      "labels": [
        "Birthday"
      ],
      "walk_in": false,
      "auto_confirmed": true,
      "partner_source": "Facebook",
      "created_date": "2019-01-01 13:30:00",
      "last_updated": "2019-01-01 13:30:00",
      "waitlisted": true,
      "waitlist_details": {
        "area": {
          "id": "525588460df6906334ca1ed7",
          "name": "Table 1",
          "zone": "533d59f80df690746c714614"
        },
        "available_time": "2021-10-22T14:36:13"
      },
      "linked_bookings": [
        {
          "id": "525588460df6906334ca1ed7"
        }
      ],
      "comments": [
        {
          "comment": "text",
          "full_name": "John Doe",
          "time": "2021-10-22T14:36:13",
          "user_id": "552439867872797140314f70"
        }
      ],
      "channel": "web",
      "offer": {
        "id": "552439867872797140314f70",
        "title": "BOGOF",
        "description": "Buy one get one free"
      },
      "notes": "I would like to sit near the window",
      "double_confirmed": true,
      "has_preorders": true,
      "preorders": {
        "id": "67b8b35cae32c8000d500a15",
        "created_date": "2025-02-21T16:09:49+00:00",
        "name": "OldPerms@CollinsB Hamuda",
        "email": "[email protected]",
        "booking_id": "67b7150dae32c8004655cfc3",
        "venue_id": "552435790df5902b7256f238",
        "venue_group": "5524371d0df590ad7156f2e9",
        "total_cost": "180",
        "amount_paid": "0",
        "service_charge_percentage": 10,
        "service_charge_amount": "18",
        "status": "complete",
        "source": "admin",
        "items": {
          "id": "5ca1de0628e7ff2356267752",
          "base_price": "13",
          "description": "<p>111</p>",
          "discount_value": "0",
          "name": "Classic Burger",
          "options_price": "0",
          "plu": 111,
          "sub_type": "bowl",
          "surcharge": 1,
          "total": "11100",
          "type": "food",
          "quantity": 3
        }
      }
    }
  ]
}

Get a booking

get

https://api.collinsbookings.com/apihttps://api-playpen.collinsbookings.com/api

/bookings/{bookingId}

Returns details about a specific booking

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

bookingIdstringRequired

The ID of the booking you want to retrieve

Responses

401

Authorization credentials were required but not found

application/json

403

The request cannot be carried out using the given credentials

404

The requested resource could not be found

application/json

422

The request could not be processed because it did not pass validation

429

The number of requests remaining in the current rate limit window has been exceeded

application/json

get

/bookings/{bookingId}

HTTPcURLJavaScriptPython

GET /api/bookings/{bookingId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "error": "Unauthenticated."
}

Get links for a booking

get

https://api.collinsbookings.com/apihttps://api-playpen.collinsbookings.com/api

/bookings/{bookingId}/links

Returns an array of URLs for customer-facing actions relating to a booking

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

bookingIdstringRequired

The ID of the booking you want to retrieve links for

Responses

200

The booking links were successfully retrieved.

application/json

calendarstringOptional

Link to download a calendar (.ics) attachment for a booking

Example: https://api.designmynight.com/v4/bookings/5d445200a3605e2bb7495514/calendar

cancelstringOptional

Link for a customer to cancel their booking

Example: https://bookings.designmynight.com/cancel-booking?booking_id=5d445200a3605e2bb7495514&access_key=ACCESS_KEY_KERE

changestringOptional

Link for a customer to change their booking

Example: https://bookings.designmynight.com/change-your-booking?booking_id=5d445200a3605e2bb7495514&access_key=ACCESS_KEY_KERE

preorderstringOptional

Link for a customer to pre-order for their booking (if enabled)

Example: https://bookings.designmynight.com/place-your-order?booking_id=5d445200a3605e2bb7495514

manage_preorderstringOptional

Link for a customer to manage pre-orders for their booking (if enabled)

Example: https://bookings.designmynight.com/manage-your-order?booking_id=5d445200a3605e2bb7495514

paymentstringOptional

Link for a customer to pay any outstanding deposits for their booking

Example: https://bookings.designmynight.com/secure-your-booking?booking_id=5d445200a3605e2bb7495514

sign_contractstringOptional

Link for a customer to sign the contract attached to their booking

Example: https://collins-customer.designmynight.com/sign-contract/5d445200a3605e2bb7495514?signature=URL_SIGNATURE_HERE

401

Authorization credentials were required but not found

application/json

403

The request cannot be carried out using the given credentials

404

The requested resource could not be found

application/json

422

The request could not be processed because it did not pass validation

429

The number of requests remaining in the current rate limit window has been exceeded

application/json

get

/bookings/{bookingId}/links

HTTPcURLJavaScriptPython

GET /api/bookings/{bookingId}/links HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "calendar": "https://api.designmynight.com/v4/bookings/5d445200a3605e2bb7495514/calendar",
  "cancel": "https://bookings.designmynight.com/cancel-booking?booking_id=5d445200a3605e2bb7495514&access_key=ACCESS_KEY_KERE",
  "change": "https://bookings.designmynight.com/change-your-booking?booking_id=5d445200a3605e2bb7495514&access_key=ACCESS_KEY_KERE",
  "preorder": "https://bookings.designmynight.com/place-your-order?booking_id=5d445200a3605e2bb7495514",
  "manage_preorder": "https://bookings.designmynight.com/manage-your-order?booking_id=5d445200a3605e2bb7495514",
  "payment": "https://bookings.designmynight.com/secure-your-booking?booking_id=5d445200a3605e2bb7495514",
  "sign_contract": "https://collins-customer.designmynight.com/sign-contract/5d445200a3605e2bb7495514?signature=URL_SIGNATURE_HERE"
}

Get assigned areas (tables) for a booking

get

https://api.collinsbookings.com/apihttps://api-playpen.collinsbookings.com/api

/bookings/{bookingId}/assigned-areas

Returns an array of areas which the booking is assigned to

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

bookingIdstringRequired

The ID of the booking you want to retrieve assigned areas for

Responses

200

The assigned areas were successfully retrieved.

application/json

401

Authorization credentials were required but not found

application/json

403

The request cannot be carried out using the given credentials

404

The requested resource could not be found

application/json

429

The number of requests remaining in the current rate limit window has been exceeded

application/json

get

/bookings/{bookingId}/assigned-areas

HTTPcURLJavaScriptPython

GET /api/bookings/{bookingId}/assigned-areas HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "assigned_areas": [
    {
      "id": "55243ccd787279304031501d",
      "name": "Table 1",
      "zone": "55243d292b588f381e7fac23"
    }
  ]
}

Replaces the assigned areas of the booking

post

https://api.collinsbookings.com/apihttps://api-playpen.collinsbookings.com/api

/bookings/{bookingId}/assigned-areas

Unassigns all areas from the booking and assigns the given ones. This request accepts an array of bookable area IDs, which you can retrieve using the Venues endpoint.

A validation error will be returned if you attempt to assign area(s) to a booking which doesn't have a venue, or if you attempt to assign area(s) which don't belong to the attached venue. Keep in mind that the request won't return an error response if you attempt to assign an area which is already assigned to the booking.

If you're looking to append assigned areas rather than replace, see Appending assigned areas.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

bookingIdstringRequired

The ID of the booking you want to assign areas for

Body

application/json

areasstring[]Optional

Array of bookable area IDs

Example: 55243ccd787279304031501d

Responses

200

The assigned areas for this booking were successfully replaced with the given areas.

application/json

401

Authorization credentials were required but not found

application/json

403

The request cannot be carried out using the given credentials

404

The requested resource could not be found

application/json

422

The request could not be processed because it did not pass validation

429

The number of requests remaining in the current rate limit window has been exceeded

application/json

post

/bookings/{bookingId}/assigned-areas

HTTPcURLJavaScriptPython

POST /api/bookings/{bookingId}/assigned-areas HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "areas": [
    "55243ccd787279304031501d"
  ]
}

{
  "assigned_areas": [
    {
      "id": "55243ccd787279304031501d",
      "name": "Table 1",
      "zone": "55243d292b588f381e7fac23"
    }
  ]
}

Appends to the assigned areas of the booking

put

https://api.collinsbookings.com/apihttps://api-playpen.collinsbookings.com/api

/bookings/{bookingId}/assigned-areas

Assigns the given areas to the booking, whilst keeping the areas which are already assigned.

This request accepts an array of bookable area IDs, which you can retrieve using the Venues endpoint.

A validation error will be returned if you attempt to assign area(s) to a booking which doesn't have a venue, or if you attempt to assign area(s) which don't belong to the attached venue. Keep in mind that the request won't return an error response if you attempt to assign an area which is already assigned to the booking.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

bookingIdstringRequired

The ID of the booking you want to assign areas for

Body

application/json

areasstring[]Optional

Array of bookable area IDs

Example: 55243ccd787279304031501d

Responses

200

The given areas were successfully assigned to the booking

application/json

401

Authorization credentials were required but not found

application/json

403

The request cannot be carried out using the given credentials

404

The requested resource could not be found

application/json

422

The request could not be processed because it did not pass validation

429

The number of requests remaining in the current rate limit window has been exceeded

application/json

put

/bookings/{bookingId}/assigned-areas

HTTPcURLJavaScriptPython

PUT /api/bookings/{bookingId}/assigned-areas HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "areas": [
    "55243ccd787279304031501d"
  ]
}

{
  "assigned_areas": [
    {
      "id": "55243ccd787279304031501d",
      "name": "Table 1",
      "zone": "55243d292b588f381e7fac23"
    }
  ]
}

Unassigns all areas from the booking

delete

https://api.collinsbookings.com/apihttps://api-playpen.collinsbookings.com/api

/bookings/{bookingId}/assigned-areas

Unassigns all areas from the booking. This request won't return an error response if the booking doesn't have any assigned areas.

If you're looking to unassign a particular area, see Unassigning an area

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

bookingIdstringRequired

The ID of the booking you want to unassign areas for

Responses

200

All areas were successfully unassigned from the booking

application/json

401

Authorization credentials were required but not found

application/json

403

The request cannot be carried out using the given credentials

404

The requested resource could not be found

application/json

429

The number of requests remaining in the current rate limit window has been exceeded

application/json

delete

/bookings/{bookingId}/assigned-areas

HTTPcURLJavaScriptPython

DELETE /api/bookings/{bookingId}/assigned-areas HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "assigned_areas": [
    {
      "id": "55243ccd787279304031501d",
      "name": "Table 1",
      "zone": "55243d292b588f381e7fac23"
    }
  ]
}

Unassigns an area from the booking

delete

https://api.collinsbookings.com/apihttps://api-playpen.collinsbookings.com/api

/bookings/{bookingId}/assigned-areas/{assignedAreaId}

Unassigns the given area from the booking.

This request will return an error response if you attempt to unassign an area which is not assigned to the booking.

If you're looking to unassign all areas, see Unassigning all areas

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

bookingIdstringRequired

The ID of the booking you want to unassign an area for

assignedAreaIdstringRequired

The ID of the area you want to unassign

Responses

200

The given area was successfully unassigned from the booking

application/json

401

Authorization credentials were required but not found

application/json

403

The request cannot be carried out using the given credentials

404

The requested resource could not be found

application/json

422

The request could not be processed because it did not pass validation

429

The number of requests remaining in the current rate limit window has been exceeded

application/json

delete

/bookings/{bookingId}/assigned-areas/{assignedAreaId}

HTTPcURLJavaScriptPython

DELETE /api/bookings/{bookingId}/assigned-areas/{assignedAreaId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "assigned_areas": [
    {
      "id": "55243ccd787279304031501d",
      "name": "Table 1",
      "zone": "55243d292b588f381e7fac23"
    }
  ]
}

Get notifications

get

https://api.collinsbookings.com/apihttps://api-playpen.collinsbookings.com/api

/bookings/{bookingId}/notifications

Returns an array of all notifications for this booking. This includes read notifications. If you only want to see unread notifications, you can use the status filter.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

statusstringOptional

Filter by the status of the booking. By default, both read and unread notifications will be returned. Use this filter to return only read or unread notifications.

typestringOptional

Filter by the type of notification.

Responses

200

Notifications were successfully retrieved

application/json

401

Authorization credentials were required but not found

application/json

403

The request cannot be carried out using the given credentials

404

The requested resource could not be found

application/json

429

The number of requests remaining in the current rate limit window has been exceeded

application/json

get

/bookings/{bookingId}/notifications

HTTPcURLJavaScriptPython

GET /api/bookings/{bookingId}/notifications HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "notifications": [
    {
      "id": "5cab15dbff3b7aae0090ad44",
      "status": "new",
      "type": "new_message"
    }
  ]
}

Get a notification

get

https://api.collinsbookings.com/apihttps://api-playpen.collinsbookings.com/api

/bookings/{bookingId}/notifications/{notificationId}

Returns the notification by the given ID.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Notification was successfully retrieved

application/json

401

Authorization credentials were required but not found

application/json

403

The request cannot be carried out using the given credentials

404

The requested resource could not be found

application/json

429

The number of requests remaining in the current rate limit window has been exceeded

application/json

get

/bookings/{bookingId}/notifications/{notificationId}

HTTPcURLJavaScriptPython

GET /api/bookings/{bookingId}/notifications/{notificationId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "notification": {
    "id": "5cab15dbff3b7aae0090ad44",
    "status": "new",
    "type": "new_message"
  }
}

Update a notification

put

https://api.collinsbookings.com/apihttps://api-playpen.collinsbookings.com/api

/bookings/{bookingId}/notifications/{notificationId}

Updates the given booking notification

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

statusstring · enumOptional

The status of the message. Unread messages have the status new and read messages have the status read.

Possible values:

Responses

200

Notification was successfully updated

application/json

401

Authorization credentials were required but not found

application/json

403

The request cannot be carried out using the given credentials

404

The requested resource could not be found

application/json

422

The request could not be processed because it did not pass validation

429

The number of requests remaining in the current rate limit window has been exceeded

application/json

put

/bookings/{bookingId}/notifications/{notificationId}

HTTPcURLJavaScriptPython

PUT /api/bookings/{bookingId}/notifications/{notificationId} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "status": "new"
}

{
  "notification": {
    "id": "5cab15dbff3b7aae0090ad44",
    "status": "new",
    "type": "new_message"
  }
}