Checkout Page
Support
Log inSign up

Update a ticket

Updates the attendee details and metadata held on a ticket. Only the fields you supply are changed; omitted fields are left as-is. Send null for attendeeName to clear it; attendeeEmail cannot be cleared. metadata takes per-entry operations matching the ticket validation endpoint: each entry adds or overwrites its key, null deletes it, and entries not named are left untouched (at most 20 entries per ticket). Requests with an empty body are rejected. When attendee details change and the booking has a ticket PDF, it is regenerated so the next download from the bookings ticket-pdf endpoint reflects them. The booking and customer records are not affected.

PATCH/v1/tickets/:ticketId

Authorization

api_key_auth
AuthorizationBearer <token>

API key authentication. Use "Bearer YOUR_API_KEY" format.

In: header

Path Parameters

ticketId*string

The ID of the ticket to update.

Match^[0-9a-fA-F]{24}$

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://api.checkoutpage.com/v1/tickets/:ticketId" \  -H "Content-Type: application/json" \  -d '{}'
{
  "data": {
    "id": "65f4a1c2e4a9f3d2b1c0a9e8",
    "seller": "string",
    "sellerId": "string",
    "charge": "string",
    "bookingId": "string",
    "orderId": "string",
    "page": "string",
    "pageId": "string",
    "ticketType": "string",
    "ticketTypeId": "string",
    "originalPrice": 0,
    "pricing": "paid",
    "discountAmount": 0,
    "feeAmount": 0,
    "taxAmount": 0,
    "couponAmount": 0,
    "complimentaryAmount": 0,
    "revenue": 0,
    "currency": "string",
    "customer": "string",
    "customerId": "string",
    "ticketShortId": "string",
    "checkInCode": "string",
    "status": "PAID",
    "checkIns": [
      {
        "status": "UNCHECKEDIN",
        "method": "QRSCAN",
        "checkedInBy": "string",
        "checkedInAt": "2019-08-24T14:15:22Z"
      }
    ],
    "latestCheckIn": {
      "status": "UNCHECKEDIN",
      "method": "QRSCAN",
      "checkedInBy": "string",
      "checkedInAt": "2019-08-24T14:15:22Z"
    },
    "customerName": "string",
    "attendeeName": "string",
    "customerEmail": "string",
    "attendeeEmail": "string",
    "livemode": true,
    "orderedAt": "2019-08-24T14:15:22Z",
    "canceledAt": "2019-08-24T14:15:22Z",
    "metadata": [
      {
        "key": "string",
        "value": "string",
        "addedAt": "2019-08-24T14:15:22Z"
      }
    ],
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}
{
  "status": "error",
  "type": "error",
  "message": "Not Found",
  "errors": [
    {
      "param": "string",
      "message": "string",
      "value": null
    }
  ],
  "property1": null,
  "property2": null
}