Comprehensive travel insurance

Modify booking

PATCH /api/partners/{partner_id}/bookings/{booking_id}

The Modify Booking API endpoint allows partners to update a confirmed booking. Partners can provide the updated values and insured parties for the booking attributes for booking modification. This endpoint requires a valid access token obtained from the Authentication.

Depending on the policies, booking modification may result in additional costs.

Path parameters

Parameter	Type	Description
partner_id	string	The partner identifier provided during onboarding
booking_id	string	Unique identifier of the booking returned in the create booking endpoint

Headers

Name	Value
Accept	application/json
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
policies	array
policies[].id	string	Unique identifier of the booking policy
policies[].update_fields	object	All booking attributes that need to be updated should be specified in this object
policies[].update_fields.policy_start_date	string/datetime	Updated policy start date
policies[].update_fields.policy_end_date	string/datetime	Updated policy end date
policies[].update_fields.trip_start_date	string/datetime	Updated start date of the trip
policies[].update_fields.trip_end_date	string/datetime	Updated end date of the trip
policies[].update_fields.sales_channel	string	Sales channel of the trip
policies[].update_fields.departure_country	string	Two letters country code of the departure country
policies[].update_fields.number_of_adults	integer	The number of adults covered in this policy
policies[].update_fields.number_of_children	integer	The number of children covered in this policy
policies[].update_fields.total_tickets_price	decimal	Total cost of the trip
policies[].update_fields.insured	array	A list of insured
policies[].update_fields.insured[].first_name	string	First name
policies[].update_fields.insured[].last_name	string	Last name
policies[].update_fields.insured[].email	string	Email address
policies[].update_fields.insured[].country	string	Two letters country code
policies[].update_fields.insured[].address1	string	Address line 1
policies[].update_fields.insured[].address2	string	Address line 2
policies[].update_fields.insured[].city	string	City of residence
policies[].update_fields.insured[].region	string	Region
policies[].update_fields.insured[].postcode	string	Postcode
policies[].update_fields.insured[].phone	string	Phone number
policies[].update_fields.insured[].birth_date	string	Date of birth
policies[].update_fields.insured[].company	string	Company name

{
    "policies": [
        {
            "id": "760dc755-0c8f-4049-83bd-b87f9a8a6391",
            "update_fields": {
                "policy_start_date": "2024-08-15T06:20:08.233Z",
                "policy_end_date": "2024-09-04T06:20:08.233Z",
                "trip_start_date": "2024-08-15T06:20:08.233Z",
                "trip_end_date": "2024-09-04T06:20:08.233Z",
                "sales_channel": "Non-HTG1",
                "departure_country": "US",
                "number_of_adults": 2,
                "number_of_children": 1,
                "total_tickets_price": 1500,
                "insured": [
                    {
                        "first_name": "Jane",
                        "last_name": "Doe",
                        "email": "[email protected]",
                        "country": "FR",
                        "address1": "50827 Halvorson Way",
                        "city": "Sydney",
                        "region": "NSW",
                        "postcode": "68988-3838",
                        "phone": "[phone]",
                        "birth_date": "1953-06-23",
                        "company": "Gibson LLC"
                    }
                ]
            }
        }
    ]
}

Response

🟢 200

{
    "data": {
        "provider_reference": "787XB-LMXLS-INS",
        "language": "en",
        "provider_customer_id": null,
        "status": "Active",
        "currency": "EUR",
        "price": 158.64,
        "security_token": "h1hpR-Z6lGK-v7eWt-7yRjh",
        "created_at": "2024-07-26T06:10:52.000000Z",
        "updated_at": "2024-07-26T06:20:08.000000Z",
        "is_instant_booking": false,
        "policies": [
            {
                "status": "Active",
                "policy_start_date": "2024-08-15T00:00:00.000000Z",
                "policy_end_date": "2024-09-04T00:00:00.000000Z",
                "price": 158.64,
                "tax": 8.64,
                "commission": 63.75,
                "cover_amount": null,
                "policy_type": "comprehensive_travel_insurance",
                "policy_code": "CN02AME",
                "policy_version": "44349651-f6c2-469e-ae38-3ef2d5728515",
                "policy_content": {
                    "title": "Comprehensive Travel Insurance",
                    "header": null,
                    "description": "-",
                    "optout_msg": "",
                    "inclusions": [],
                    "exclusions": [],
                    "disclaimer": "This policy is provided by Cover Genius Europe B.V. and underwritten by Cowen Insurance Company Ltd. By adding protection you confirm you have read and agree to the Policy Terms and Insurance Product Information Document. You agree to receive the policy documentation electronically.Cover Genius Europe B.V. is registered at the Dutch Chamber of Commerce under number 73237426 and licensed as an insurance intermediary and authorised agent at the Dutch Authority for the Financial Markets under license number 12046177. XCover.com is a trading name of Cover Genius Europe B.V.Cowen Insurance Company Ltd, bearing Malta Company Registration Number C55905, is a Company authorised by the Malta Financial Services Authority (MFSA) to carry out general Insurance business under the insurance business act, 1998, of the laws of Malta. HomeToGo GmbH is an Ancillary Insurance Intermediary of Cover Genius Europe B.V.",
                    "disclaimer_html": "<p data-block-key=\"3amlk\">This policy is provided by Cover Genius Europe B.V. and underwritten by Cowen Insurance Company Ltd. By adding protection you confirm you have read and agree to the <a href=\"https://www.xcover.com/en/pds/787XB-LMXLS-INS?policy_type=comprehensive_travel_insurance_v2\" rel=\"noopener noreferrer\" target=\"_blank\">Policy Terms</a> and <a href=\"https://static.xcover.com/media/pds/cea422a7-e2db-4dca-9f42-be7362405e25/IPID_Comprehensive_EN.pdf\" rel=\"noopener noreferrer\" target=\"_blank\">Insurance Product Information Document</a>. You agree to receive the policy documentation electronically.</p><p data-block-key=\"37q1a\">Cover Genius Europe B.V. is registered at the Dutch Chamber of Commerce under number 73237426 and licensed as an insurance intermediary and authorised agent at the Dutch Authority for the Financial Markets under license number 12046177. XCover.com is a trading name of Cover Genius Europe B.V.</p><p data-block-key=\"bvj7t\">Cowen Insurance Company Ltd, bearing Malta Company Registration Number C55905, is a Company authorised by the Malta Financial Services Authority (MFSA) to carry out general Insurance business under the insurance business act, 1998, of the laws of Malta. HomeToGo GmbH is an Ancillary Insurance Intermediary of Cover Genius Europe B.V.</p>",
                    "payment_disclaimer": "",
                    "in_path_disclaimer": "",
                    "extra_content": []
                },
                "claim_selector_id": null,
                "pds_url": "https://www.xcover.com/en/pds/787XB-LMXLS-INS?policy_type=comprehensive_travel_insurance_v2",
                "extra_fields": {
                    "bundled_retail_premium": "158.6399999999999976298126203"
                },
                "confirmed_at": "2024-07-26T06:10:53.000000Z",
                "cancelled_at": null,
                "created_at": "2024-07-26T06:10:52.000000Z",
                "updated_at": "2024-07-26T06:20:08.000000Z",
                "id": "760dc755-0c8f-4049-83bd-b87f9a8a6391"
            }
        ],
        "policyholder": {
            "first_name": "Kaitlin",
            "last_name": "Brown",
            "email": "[email protected]",
            "phone": "[phone]",
            "country": "FR",
            "date_of_birth": null,
            "address1": "50827 Halvorson Way",
            "address2": null,
            "city": "Sydney",
            "region": "NSW",
            "postcode": "68988-3838",
            "created_at": "2024-07-26T06:10:52.000000Z",
            "updated_at": "2024-07-26T06:10:52.000000Z",
            "id": "3dfa6c1e-3db3-4782-8f9c-23ccb9fb2c19"
        },
        "id": "56fae9c9-40f9-40a6-8599-e6cf87bdea2e",
        "partner": {
            "uuid": "4f607e20-bfa6-4d46-8f6b-462bc970be9d",
            "name": "Secret Escapes"
        },
        "quote": {
            "uuid": "71c47fa0-a9df-4fd5-b175-9c56d52660fb"
        },
        "cancellations": []
    }
}

🔴 401

{
    "message": "Unauthenticated."
}

🔴 422

{
    "message": "The request is invalid."
}