Allows you to add tickets to a specific ticket event. This endpoint creates new tickets with the specified information for the purchaser and ticket holders.
contact_first_name - First name of the ticket purchasercontact_last_name - Last name of the ticket purchasercontact_email - Email address of the ticket purchaserticket_level_id - Ticketable level IDticket_quantity - Number of tickets to createticket_pricing - Price of the ticket in dollars (0 for free tickets)contact_dobcontact_agecontact_gendercontact_phonecontact_address1contact_citycontact_statecontact_countrycodecontact_zipcodeticket_first_nameticket_last_nameticket_emailticket_dobticket_ageticket_genderticket_phoneticket_address1ticket_cityticket_stateticket_countrycodeticket_zipcodeticket_purchase_dateImportant: This API does not support timed entry events. If you need to import tickets for timed entry events, please use the manual entry feature available on the ticket dashboard.
Notes: The maximum number of ticket purchases in the tickets array per request must be fewer than 50.
The order of values in each ticket array must match the order of columns defined in the "columns" array.
Each value corresponds to the column at the same position.
If you set the auto_check_in parameter to true, all imported tickets will be automatically checked in upon creation.
{
"columns": [
"contact_first_name",
"contact_last_name",
"contact_email",
"contact_phone",
"contact_address1",
"contact_city",
"contact_state",
"contact_countrycode",
"contact_zipcode",
"ticket_first_name",
"ticket_last_name",
"ticket_email",
"ticket_level_id",
"ticket_quantity",
"ticket_pricing"
],
"tickets": [
["John", "Smith", "john.smith@example.com", "555-123-4567", "123 Main St", "Philadelphia", "PA", "US", "19001", "John", "Smith", "john.smith@example.com", 7, 1, 0],
["Jane", "Doe", "jane.doe@example.com", "555-234-5678", "456 Oak St", "Beverly Hills", "CA", "US", "90210", "Jane", "Doe", "jane.doe@example.com", 7, 1, 0],
["Bob", "Lee", "bob.lee@example.com", "555-345-6789", "789 Pine St", "Houston", "TX", "US", "77001", "Bob", "Lee", "bob.lee@example.com", 7, 2, 0]
]
}
The ticket_ids array contains one entry for each ticket actually created.
Since each row in your tickets array can specify a ticket_quantity greater than 1, you may get more IDs here than you have rows above.
In the example below, three rows (quantities 1, 1, and 2) produce four ticket IDs.
{
"ticket_ids": [2388, 2389, 2390, 2391],
"num_tickets_added": 4
}
| Parameter | HTTP Method | Default | Description | Datatype |
|---|---|---|---|---|
ticket_event_idRequired |
GET | ID of ticket event. | uint |
|
rsu_api_key |
GET | API key. | string |
|
X-RSU-API-SECRET |
HTTP Header | API secret. | string |
|
auto_check_in |
GET | F | Automatically check in the newly created tickets? | bool |
device_name |
GET | Device name used for automatically checking in created tickets. Applicable only when `auto_check_in` is enabled. | string |
|
device_uuid |
GET | Device UUID used for automatically checking in created tickets. Applicable only when `auto_check_in` is enabled. | string |
|
request |
POST | Request in proper format. | string |
{
"openapi": "3.0.3",
"info": {
"title": "Add Tickets",
"description": "Add tickets for a ticket event.",
"version": "1.0.0",
"contact": {
"name": "RunSignup API Support",
"url": "https://runsignup.com/API",
"email": "info@runsignup.com"
}
},
"servers": [
{
"url": "https://api.runsignup.com/rest",
"description": "Production API Server"
}
],
"tags": [
{
"name": "Ticket Events",
"description": "APIs related to Ticket Events"
}
],
"components": {
"schemas": {
"Error": {
"type": "object",
"properties": {
"error": {
"type": "string",
"description": "Error message"
},
"details": {
"type": "object",
"description": "Additional error details",
"additionalProperties": true
}
},
"required": [
"error"
]
},
"BadRequestError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating invalid request parameters or structure"
}
]
},
"UnauthorizedError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating authentication failure"
}
]
},
"ForbiddenError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating the authenticated user lacks required permissions"
}
]
},
"NotFoundError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating the requested resource does not exist"
}
]
},
"ServerError": {
"allOf": [
{
"$ref": "#/components/schemas/Error"
},
{
"description": "Error indicating an unexpected server-side issue"
}
]
}
},
"securitySchemes": {
"apiKey": {
"type": "apiKey",
"in": "query",
"name": "api_key",
"description": "RunSignup API Key"
},
"apiSecret": {
"type": "apiKey",
"in": "query",
"name": "api_secret",
"description": "RunSignup API Secret"
}
}
},
"paths": {
"/v2/tickets/add-tickets.json": {
"post": {
"tags": [
"Ticket Events"
],
"summary": "Add Tickets",
"description": "Add tickets for a ticket event.",
"operationId": "v2_tickets_add_tickets_json",
"parameters": [
{
"name": "ticket_event_id",
"in": "query",
"description": "ID of ticket event.",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "checkin_api_key",
"in": "query",
"description": "Checkin API key.",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "X-CHECKIN-API-SECRET",
"in": "header",
"description": "Checkin API secret.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "rsu_api_key",
"in": "query",
"description": "API key.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "X-RSU-API-SECRET",
"in": "header",
"description": "API secret.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "auto_check_in",
"in": "query",
"description": "Automatically check in the newly created tickets?",
"required": false,
"schema": {
"type": "boolean",
"enum": [
"T",
"F"
],
"default": "F"
}
},
{
"name": "device_name",
"in": "query",
"description": "Device name used for automatically checking in created tickets. Applicable only when `auto_check_in` is enabled.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "device_uuid",
"in": "query",
"description": "Device UUID used for automatically checking in created tickets. Applicable only when `auto_check_in` is enabled.",
"required": false,
"schema": {
"type": "string"
}
}
],
"security": [
{
"apiKey": [],
"apiSecret": []
}
],
"responses": {
"200": {
"description": "Successful response",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequestError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedError"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenError"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFoundError"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServerError"
}
}
}
}
},
"x-permissions": [],
"requestBody": {
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"request": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
