EventProducts
Create EventProduct
Create a new EventProduct record.
POST
Create EventProduct
An EventProduct links a product to a calendar event, allowing products to be sold as part of event registration (e.g. event tickets, catering add-ons).
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-Create role.Request Body
Required Fields
integer
required
ID of the calendar event linked to this record.
string
required
The name value for this event product.
integer
required
The display order value for this event product.
string
required
Date/time value for start date.
string
required
Date/time value for end date.
number
required
Unit price amount.
integer
required
ID of the currency linked to this record.
Optional Fields
string
Free-text description of this event product.
string
The ticket notes value for this event product.
boolean
Whether visible is enabled.
integer
The allocation value for this event product.
integer
The max tickets per attendee value for this event product.
integer
ID of the tax rate linked to this record.
integer
ID of the financial account linked to this record.
integer[]
List of tariffs linked to this record.
boolean
Whether only for contacts is enabled.
boolean
Whether only for members is enabled.
Code Examples
Response
200
integer
HTTP status code.
200 on success.string
A human-readable message confirming the creation.
object
Contains the
Id of the newly created record.boolean
true if the eventproduct was created 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
Create EventProduct