Freshtix

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.event_datetime	string/datetime	Updated event date time
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.number_of_tickets	integer	Updated number of tickets covered in this policy
policies[].update_fields.tickets	array	An array of tickets to be covered in this policy
policies[].update_fields.tickets[].price	decimal	The price of the ticket
policies[].update_fields.tickets[].type	string	Ticket type
policies[].update_fields.tickets[].scanned_at	string/datetime	The date time when the ticket was scanned.
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": "dcea9814-3c5a-4be3-bfc6-4be842f46542",
      "update_fields": {
        "event_datetime": "2024-08-21T04:55:06.649Z",
        "policy_start_date": "2024-07-12T04:55:06.649Z",
        "number_of_tickets": 1,
        "policy_end_date": "2024-08-21T04:55:06.649Z",
        "tickets": [
          {
            "price": 35,
            "type": "Second Release",
            "scanned_at": null
          }
        ],
        "insured": [
          {
            "first_name": "Katrina",
            "last_name": "Brown modified"
          }
        ]
      }
    }
  ]
}

Response

🟢 201

{
    "data": {
        "provider_reference": "NULKR-DDKPL-INS",
        "language": "en-us",
        "provider_customer_id": null,
        "status": "Active",
        "currency": "USD",
        "price": 59.64,
        "security_token": "kzEuw-7g4XC-rE68C-2btrf",
        "created_at": "2024-08-29T00:10:06.000000Z",
        "updated_at": "2024-08-29T00:11:40.000000Z",
        "is_instant_booking": false,
        "policies": [
            {
                "status": "Active",
                "policy_start_date": "2024-08-29T00:00:00.000000Z",
                "policy_end_date": "2024-09-28T00:00:00.000000Z",
                "price": 59.64,
                "tax": 0,
                "commission": 34.08,
                "cover_amount": null,
                "policy_type": "event_ticket_protection",
                "policy_code": "FTMUSV01",
                "policy_version": "a7a8ee25-19fd-492a-9b96-e3d6ce402b26",
                "policy_content": {
                    "title": "Booking Refund Protection",
                    "header": null,
                    "description": "N/A",
                    "optout_msg": "",
                    "inclusions": [],
                    "exclusions": [],
                    "disclaimer": "This refund protection product is administered by XCover. By clicking the button you agree that you have read and accept the terms and conditions.",
                    "disclaimer_html": "<p data-block-key=\"cgh44\">This refund protection product is administered by XCover. By clicking the button you agree that you have read and accept the <a href=\"https://www.xcover.com/en-us/pds/NULKR-DDKPL-INS?policy_type=event_ticket_protection_v1\" rel=\"noopener noreferrer\" target=\"_blank\">terms and conditions.</a></p>",
                    "payment_disclaimer": "",
                    "in_path_disclaimer": "",
                    "extra_content": []
                },
                "claim_selector_id": null,
                "pds_url": "https://www.xcover.com/en-us/pds/NULKR-DDKPL-INS?policy_type=event_ticket_protection_v1",
                "extra_fields": {
                    "seller_entity": "Cover Genius Insurance Services LLC",
                    "event_datetime": "2024-09-28T00:09:55.502Z",
                    "event_cost": "852",
                    "retail_price": "59.64000000000000567546010188",
                    "uw_fee": "4.792499999999999822641871816",
                    "reinsurer_fee": "14.37749999999999946792561545",
                    "partner_commission": "34.08000000000000070943251274",
                    "coverage_group": "US-Plan A",
                    "cg_booking_fee": "6.38999999999999999999999999"
                },
                "confirmed_at": "2024-08-29T00:10:06.000000Z",
                "cancelled_at": null,
                "created_at": "2024-08-29T00:10:06.000000Z",
                "updated_at": "2024-08-29T00:11:40.000000Z",
                "id": "dd50d4eb-9ce0-4737-8d0c-39ac068c23de"
            }
        ],
        "policyholder": {
            "first_name": "Kaitlin",
            "last_name": "Brown",
            "email": "[email protected]",
            "phone": "[phone]",
            "country": "US",
            "date_of_birth": null,
            "address1": "50827 Halvorson Way",
            "address2": null,
            "city": "Sydney",
            "region": "NSW",
            "postcode": "68988-3838",
            "created_at": "2024-08-29T00:10:06.000000Z",
            "updated_at": "2024-08-29T00:10:06.000000Z",
            "id": "dce3cebe-2281-439f-aba1-94fac7cd5a33"
        },
        "id": "874b9dea-9df2-40f8-80a8-6e639708bbff",
        "partner": {
            "uuid": "723a4302-cd8d-4bd4-b012-486525167b4b",
            "name": "Freshtix"
        },
        "quote": {
            "uuid": "89c653ef-233c-472a-9f97-fdbde40d965f"
        },
        "cancellations": []
    }
}

🔴 401

{
    "message": "Unauthenticated."
}

🔴 422

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