PATCH

Update Ticket


Updates a ticket.

Authentication

You can only call this method when authenticated as a Wix app or Wix user identity.

Permissions
Manage Events - all permissions
Manage Guest List
Learn more about app permissions.
Endpoint
PATCH
https://www.wixapis.com/events/v1/events/{eventId}/tickets/{ticketNumber}

Path Params
eventIdstringRequired

Event ID.


ticketNumberstringRequired

Unique ticket number.

Body Params
fieldsFields

Set of field paths, specifying which parts of this resource to update. When fields is empty, the request is interpreted as a full update. Behavior follows google.protobuf.FieldMask semantics.


archivedboolean

Whether ticket is archived.


guestDetailsGuestDetails

Assigned guest details.

Response Object
ticketTicket

Updated ticket.

Ticket can be archived and unarchived through ticket update.

Request
cURL
curl -X PATCH 'https://www.wixapis.com/events/v1/events/ad18d12e-a6a9-4c17-abfa-6ff119479be2/tickets/FNVL-NIJT-WP021' \ -H 'Content-Type: application/json' \ -H 'Authorization: <AUTH TOKEN>' \ -d @- << EOF { "archived": true, "fields": { "paths": [ "archived" ] } } EOF
Response
JSON
{ "ticket": { "ticketNumber": "FNVL-NIJT-WP021", "orderNumber": "FNVL-NIJT-WP", "ticketDefinitionId": "d86ffbbd-aa9b-488d-a14b-11752b78e272", "name": "Early Bird", "price": { "amount": "12.34", "currency": "USD" }, "free": false, "policy": "This is your event ticket. Ticket holders must present their tickets on entry.", "orderStatus": "PAID", "orderArchived": false, "orderFullName": "John Doe", "guestDetails": { "guestAssigned": false, "firstName": "John", "lastName": "Doe", "email": "john.doe@example.com", "contactId": "3ef81e9f-106e-408d-a3ee-3df60838acc6" }, "archived": true, "anonymized": false, "checkInUrl": "https://www.wixevents.com/check-in/FNVL-NIJT-WP021,ad18d12e-a6a9-4c17-abfa-6ff119479be2", "ticketPdfUrl": "https://apps.wix.com/events/doc/tickets/Ticket.pdf?request=<TOKEN>" } }
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Event TriggersThis method triggers the following events:
Did this help?