{"__v":0,"_id":"55274aed9d4bcd2300d0383f","category":{"__v":2,"_id":"552748df9d4bcd2300d0383d","pages":["55274cdebf3df9230068f7b1","55274e785296eb3900185abd"],"project":"545a65231d018b1400227d8f","version":"54e431e6de9f5b2300fc6dbc","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-04-10T03:51:59.068Z","from_sync":false,"order":9,"slug":"ticket-api","title":"TICKET API"},"editedParams":true,"editedParams2":true,"project":"545a65231d018b1400227d8f","user":"545a64cfbf1d2b0e00aaa091","version":{"__v":10,"_id":"54e431e6de9f5b2300fc6dbc","forked_from":"545a65231d018b1400227d92","project":"545a65231d018b1400227d8f","createdAt":"2015-02-18T06:32:06.531Z","releaseDate":"2015-02-18T06:32:06.531Z","categories":["54e431e7de9f5b2300fc6dbd","54e431e7de9f5b2300fc6dbe","54e56a85c2f66835000133c3","54ff948548c94d23004f1e17","5527280be69c7d0d00047eaf","55273bb14a7ac121004c60f0","55274588975eef3700ca8077","552748df9d4bcd2300d0383d","55274dd79d4bcd2300d0384a","55fa03180e1f1f1700a1f6ce","55fa3172d6f4370d001d99fd"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-04-10T04:00:45.680Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n  \"Status\": \"ok\",\n  \"Result\": {\n    \"ID\": 7493,\n    \"UserID\": 3,\n    \"EventID\": 5,\n    \"TicketsPoolID\": 10,\n    \"Name\": \"Test ticket number one\",\n    \"Description\": \"General\",\n    \"Message\": \"\",\n    \"Total\": 1000,\n    \"Price\": 0,\n    \"Earlybird\": false,\n    \"EarlybirdPrice\": 0,\n    \"EarlybirdDate\": \"0001-01-01T00:00:00Z\",\n    \"EarlybirdExpiryShow\": false,\n    \"DefaultQuantity\": 10,\n    \"Type\": \"normal\",\n    \"Mode\": \"standard\",\n    \"Order\": 1,\n    \"MinimumQuantity\": 1,\n    \"Available\": false,\n    \"TotalAvailable\": 0,\n    \"Purchased\": 0,\n    \"Status\": \"active\"\n  }\n}","language":"json","status":201}]},"auth":"required","params":[{"_id":"54e56a19c2f66835000133c0","ref":"","in":"body","required":true,"desc":"The Event id for this ticket","default":"","type":"int","name":"EventID"},{"_id":"54e56a19c2f66835000133bf","ref":"","in":"body","required":false,"desc":"The Ticketspool Id for this ticket","default":"","type":"int","name":"TicketspoolID"},{"_id":"54ffd2d9179d042d00514eb4","ref":"","in":"body","required":true,"desc":"Ticket name (100 chars max)","default":"","type":"string","name":"Name"},{"_id":"54ffd2d9179d042d00514ea9","ref":"","in":"body","required":false,"desc":"Ticket description (250 chars max)","default":"","type":"string","name":"Description"},{"_id":"55273cf2975eef3700ca8072","ref":"","in":"body","required":false,"desc":"Ticket message that is shown on receipt page if this ticket is selected","default":"","type":"string","name":"Message"},{"_id":"55273cf2975eef3700ca8071","ref":"","in":"body","required":true,"desc":"Total number of these tickets available","default":"1000","type":"int","name":"Total"},{"_id":"55274aed9d4bcd2300d03848","ref":"","in":"body","required":false,"desc":"Price of the ticket","default":"0","type":"double","name":"Price"},{"_id":"55274aed9d4bcd2300d03847","ref":"","in":"body","required":false,"desc":"Does this ticket have earlybird pricing","default":"false","type":"boolean","name":"Earlybird"},{"_id":"55274aed9d4bcd2300d03846","ref":"","in":"body","required":false,"desc":"Earlybird price","default":"0","type":"double","name":"EarlybirdPrice"},{"_id":"55274aed9d4bcd2300d03845","ref":"","in":"body","required":false,"desc":"When earlybird pricing finishes","default":"","type":"datetime","name":"EarlybirdDate"},{"_id":"55274aed9d4bcd2300d03844","ref":"","in":"body","required":false,"desc":"Should we show the expiry date for earlybird pricing","default":"false","type":"boolean","name":"EarlybirdExpiryShow"},{"_id":"55274aed9d4bcd2300d03843","ref":"","in":"body","required":false,"desc":"The maximum amount of these tickets you are allowed to buy at once","default":"10","type":"int","name":"DefaultQuantity"},{"_id":"55274aed9d4bcd2300d03842","ref":"","in":"body","required":false,"desc":"Type of ticket (always use \"normal\")","default":"normal","type":"string","name":"Type"},{"_id":"55274aed9d4bcd2300d03841","ref":"","in":"body","required":false,"desc":"Order of the ticket in relation to other tickets","default":"10","type":"int","name":"Order"},{"_id":"55274aed9d4bcd2300d03840","ref":"","in":"body","required":false,"desc":"The minimum number of tickets an attendee needs to buy","default":"1","type":"int","name":"MinimumQuantity"},{"_id":"55273cf2975eef3700ca806b","ref":"","in":"body","required":true,"desc":"The ticket status","default":"active","type":"string","name":"Status"}],"url":"/ticket"},"isReference":false,"order":0,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X POST  -u \\\"testuser:moy1zZCscHpx7ei8CzNA\\\" -H \\\"Cache-Control: no-cache\\\"  -d '{\\n\\t\\\"Ticket\\\": {\\n\\t\\t\\t\\t\\\"Name\\\": \\\"Test ticket number one\\\",\\n\\t\\t\\t\\t\\\"Description\\\": \\\"General\\\",\\n\\t\\t\\t\\t\\\"Price\\\": 0,\\n\\t\\t\\t\\t\\\"Total\\\": 1000,\\n\\t\\t\\t\\t\\\"Order\\\": 1,\\n\\t\\t\\t\\t\\\"Status\\\": \\\"active\\\"\\n\\t\\t\\t}\\n}' https://api.attendly.net/v2/ticket\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]","excerpt":"Create a ticket for an event","slug":"ticket-create","type":"post","title":"Ticket create"}

postTicket create

Create a ticket for an event

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

EventID:
required
integer
The Event id for this ticket
TicketspoolID:
integer
The Ticketspool Id for this ticket
Name:
required
string
Ticket name (100 chars max)
Description:
string
Ticket description (250 chars max)
Message:
string
Ticket message that is shown on receipt page if this ticket is selected
Total:
required
integer1000
Total number of these tickets available
Price:
double0
Price of the ticket
Earlybird:
booleanfalse
Does this ticket have earlybird pricing
EarlybirdPrice:
double0
Earlybird price
EarlybirdDate:
datetime
When earlybird pricing finishes
EarlybirdExpiryShow:
booleanfalse
Should we show the expiry date for earlybird pricing
DefaultQuantity:
integer10
The maximum amount of these tickets you are allowed to buy at once
Type:
stringnormal
Type of ticket (always use "normal")
Order:
integer10
Order of the ticket in relation to other tickets
MinimumQuantity:
integer1
The minimum number of tickets an attendee needs to buy
Status:
required
stringactive
The ticket status

Result Format


Documentation

[block:code] { "codes": [ { "code": "curl -X POST -u \"testuser:moy1zZCscHpx7ei8CzNA\" -H \"Cache-Control: no-cache\" -d '{\n\t\"Ticket\": {\n\t\t\t\t\"Name\": \"Test ticket number one\",\n\t\t\t\t\"Description\": \"General\",\n\t\t\t\t\"Price\": 0,\n\t\t\t\t\"Total\": 1000,\n\t\t\t\t\"Order\": 1,\n\t\t\t\t\"Status\": \"active\"\n\t\t\t}\n}' https://api.attendly.net/v2/ticket", "language": "curl" } ] } [/block]