EventProducts
Update EventProduct
Update an existing EventProduct record.
PUT
Update EventProduct
Updates an existing EventProduct record. You must include the
Id of the record to update along with all required fields.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the EventProduct-Edit role.Request Body
Required Fields
integer
required
The Id of the EventProduct record to update.
integer
required
ID of the event this ticket belongs to; the event’s location determines the owning location for this record..
string
required
Required ticket name shown to customers on the Members Portal and app..
integer
required
Display position of this ticket among the event’s tickets; lower values appear first..
string
required
UTC start of the inclusive window during which this ticket can be purchased; must not be after EndDate..
string
required
UTC end of the inclusive window during which this ticket can be purchased; must not be before StartDate..
number
required
Price charged per ticket in the selected currency; zero makes the ticket free (RSVP only)..
integer
required
ID of the ISO 4217 currency used for the ticket price..
Optional Fields
string
Optional plain-text description of this ticket shown on the Members Portal and app..
string
Optional plain-text notes appended to the confirmation message sent to customers who purchase this ticket..
boolean
Whether customers can see and purchase this ticket from the Members Portal and app; when false the ticket is hidden from the storefront..
integer
Maximum number of this ticket type that can be sold; leave empty for no product-specific cap, while the event’s overall capacity still applies..
integer
Maximum number of this ticket a single customer can purchase; leave empty for no per-customer limit..
integer
Optional ID of the tax rate applied when this ticket is invoiced; required when the event’s location requires tax rates..
integer
Optional ID of the financial account used to record ticket revenue; required when the event’s location requires financial accounts..
boolean
Whether only contacts, meaning customers without an active contract, can purchase this ticket; this combines with every other targeting rule, so setting it with OnlyForMembers makes the ticket unavailable to all customers..
boolean
Whether only members, meaning customers with an active contract, can purchase this ticket; this combines with every other targeting rule, so setting it with OnlyForContacts makes the ticket unavailable to all customers..
integer[]
List of plans a customer’s active contract must use to purchase this ticket; an empty list applies no plan restriction, and a non-empty list is enforced in addition to other targeting rules..
integer[]
IDs added to the Tariffs relationship..
integer[]
IDs removed from the Tariffs relationship..
integer[]
List of specific customers who can purchase this ticket; an empty list applies no customer-specific restriction, and a non-empty list is enforced in addition to plan, team, member, and contact rules..
integer[]
IDs added to the Members relationship..
integer[]
IDs removed from the Members relationship..
integer[]
List of teams a customer must belong to to purchase this ticket; an empty list applies no team restriction, and a non-empty list is enforced in addition to other targeting rules..
integer[]
IDs added to the Teams relationship..
integer[]
IDs removed from the Teams relationship..
Code Examples
Response
200
integer
HTTP status code.
200 on success.string
A human-readable message confirming the update.
object
Contains the
Id of the updated record.boolean
true if the eventproduct was updated successfully.array
null on success.Example Response
400
string
A summary of the validation error(s), in the format
PropertyName: error message.any
null on validation failure.object[]
Array of validation errors.
boolean
false when the request fails validation.Example Response