{"__v":1,"_id":"54ffd33c564faf2f008e123d","category":{"__v":17,"_id":"54e431e7de9f5b2300fc6dbe","pages":["54e431e7de9f5b2300fc6dc0","54e56a19c2f66835000133be","54f646a1542ade0d00f1c686","54f675a4b175300d00d44b9f","54f675f31ad1c41900a4815f","54f67f4cd53b280d00b6c4a8","54ffd33c564faf2f008e123d","551233b80c1a08190077f97a","551234a9f9ece423005b244c","552728a2e69c7d0d00047eb0","5527296e975eef3700ca805c","55272a19d7ea1c2300e58aa3","55272a8d7d4a4417009516f8","55272ac0d7ea1c2300e58aa4","552744574a7ac121004c60f6","552744d3975eef3700ca8075","55596943dab6630d00792641"],"project":"545a65231d018b1400227d8f","version":"54e431e6de9f5b2300fc6dbc","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-11-05T17:59:19.427Z","from_sync":false,"order":4,"slug":"event-api","title":"EVENT 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-03-11T05:31:40.246Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n  \"Status\": \"ok\",\n  \"Result\": {\n      \"ID\": 3535,\n      \"Name\": \"A grand event\",\n      \"Description\": \"This is just a test event.\",\n      \"PresentedBy\": \"\",\n      \"NotAvailableMessage\": \"\",\n      \"ThanksMessage\": \"\",\n      \"EmailMessage\": \"\",\n      \"FooterText\": \"\",\n      \"Notification\": false,\n      \"ShowDetails\": false,\n      \"ShowComments\": false,\n      \"ShowSocialMedia\": false,\n      \"ShowDeadline\": false,\n      \"AttachTicket\": false,\n      \"Deadline\": \"2015-11-07T23:00:00Z\",\n      \"Start\": \"2015-11-10T23:00:00Z\",\n      \"Stop\": \"2015-11-10T23:00:00Z\",\n      \"ActiveStart\": \"2000-01-01T01:00:00Z\",\n      \"Terms\": \"\",\n      \"PushURL\": \"\",\n      \"Subdomain\": \"reg\",\n      \"ReturnURL\": \"\",\n      \"Hashtag\": \"\",\n      \"Currency\": \"\",\n      \"AdwordsTrackingCode\": \"\",\n      \"Password\": \"\",\n      \"TimezoneName\": \"Australia/Melbourne\",\n      \"UserID\": 3,\n      \"GroupID\": 3,\n      \"GroupName\": \"Some events\",\n      \"Status\": \"active\",\n      \"Available\": true,\n      \"TimeTillStart\": \"5 months from now\",\n      \"TimeTillDeadline\": \"5 months from now\",\n      \"EditDeadline\": \"2014-01-01T00:00:00Z\",\n      \"EditUserDetails\": false,\n      \"URL\": \"https://test.canbook.me/testevent\"\n    }\n}","language":"json","status":200}]},"auth":"required","params":[{"_id":"54e56a19c2f66835000133c0","ref":"","in":"body","required":true,"desc":"The name of the event","default":"","type":"string","name":"Name"},{"_id":"54e56a19c2f66835000133bf","ref":"","in":"body","required":true,"desc":"The description of the event. This can be HTML","default":"","type":"string","name":"Description"},{"_id":"54ffd2d9179d042d00514eb4","ref":"","in":"body","required":true,"desc":"The deadline for buying a ticket","default":"","type":"datetime","name":"Deadline"},{"_id":"54ffd2d9179d042d00514eb3","ref":"","in":"body","required":true,"desc":"The start date / time of the event","default":"","type":"datetime","name":"Start"},{"_id":"54ffd2d9179d042d00514eb2","ref":"","in":"body","required":true,"desc":"The stop date / time of the event","default":"","type":"datetime","name":"Stop"},{"_id":"54ffd2d9179d042d00514ebf","ref":"","in":"body","required":false,"desc":"Who is this event presented by?","default":"","type":"string","name":"PresentedBy"},{"_id":"54ffd2d9179d042d00514ebe","ref":"","in":"body","required":false,"desc":"The message that appears when the event is not available","default":"","type":"string","name":"NotAvailableMessage"},{"_id":"54ffd2d9179d042d00514ebd","ref":"","in":"body","required":false,"desc":"This message appears on the thanks page after the attendee has registered","default":"","type":"string","name":"ThanksMessage"},{"_id":"54ffd2d9179d042d00514ebc","ref":"","in":"body","required":false,"desc":"This is the message that appears in the confirmation email to the attendee when they register","default":"","type":"string","name":"EmailMessage"},{"_id":"54ffd2d9179d042d00514ebb","ref":"","in":"body","required":false,"desc":"Appears on the footer of the confirmation email","default":"","type":"string","name":"FooterText"},{"_id":"54ffd2d9179d042d00514eba","ref":"","in":"body","required":false,"desc":"Set to true if you want to receive an email every time an attendee registers","default":"false","type":"boolean","name":"Notification"},{"_id":"54ffd2d9179d042d00514eb9","ref":"","in":"body","required":false,"desc":"Set to false to hide the details of the event on the ticket entry page","default":"true","type":"boolean","name":"ShowDetails"},{"_id":"54ffd2d9179d042d00514eb8","ref":"","in":"body","required":false,"desc":"Set to true to allow comments","default":"false","type":"boolean","name":"ShowComments"},{"_id":"54ffd2d9179d042d00514eb7","ref":"","in":"body","required":false,"desc":"Show social media throughout the register process","default":"true","type":"boolean","name":"ShowSocialMedia"},{"_id":"54ffd2d9179d042d00514eb6","ref":"","in":"body","required":false,"desc":"Show the ticket deadline","default":"true","type":"boolean","name":"ShowDeadline"},{"_id":"54ffd2d9179d042d00514eb5","ref":"","in":"body","required":false,"desc":"Attach a PDF version of the ticket to the confirmation email","default":"true","type":"boolean","name":"AttachTicket"},{"_id":"54ffd2d9179d042d00514eb1","ref":"","in":"body","required":false,"desc":"Use this to set when the event becomes available","default":"","type":"datetime","name":"ActiveStart"},{"_id":"54ffd2d9179d042d00514eb0","ref":"","in":"body","required":false,"desc":"Extra terms and conditions","default":"","type":"string","name":"Terms"},{"_id":"54ffd2d9179d042d00514eaf","ref":"","in":"body","required":false,"desc":"Set this to a URL to receive push notifications (JSON) for events like when an attendee registers etc.","default":"","type":"string","name":"PushURL"},{"_id":"54ffd2d9179d042d00514eae","ref":"","in":"body","required":false,"desc":"The default subdomain to use for the registration URL","default":"","type":"string","name":"Subdomain"},{"_id":"54ffd2d9179d042d00514ead","ref":"","in":"body","required":false,"desc":"Set this to a URL if you want the attendee to be redirected at the end of the registration process","default":"","type":"string","name":"ReturnURL"},{"_id":"54ffd2d9179d042d00514eac","ref":"","in":"body","required":false,"desc":"Set to a twitter hashtag you would like to associate with the event","default":"","type":"string","name":"Hashtag"},{"_id":"54ffd2d9179d042d00514eab","ref":"","in":"body","required":false,"desc":"AUD, USD, EUR, GBP etc.","default":"","type":"string","name":"Currency"},{"_id":"54ffd2d9179d042d00514eaa","ref":"","in":"body","required":false,"desc":"Set a password to access the event","default":"","type":"string","name":"Password"},{"_id":"54ffd2d9179d042d00514ea9","ref":"","in":"body","required":true,"desc":"Set to 'draft' to disable the event","default":"active","type":"string","name":"Status"}],"url":"/event"},"isReference":false,"order":1,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X POST  -u \\\"testuser:moy1zZCscHpx7ei8CzNA\\\" -H \\\"Cache-Control: no-cache\\\"  -d '{\\n\\t\\\"Event\\\": {\\n\\t\\t\\\"Name\\\": \\\"Test Active Event\\\",\\n\\t\\t\\\"Description\\\": \\\"<p>This is just a test event. Note <strong>HTML</strong></p>\\\",\\n\\t\\t\\\"Deadline\\\": \\\"2015-11-10T23:00:00Z\\\",\\n\\t\\t\\\"Start\\\": \\\"2015-11-10T23:00:00Z\\\",\\n\\t\\t\\\"Stop\\\": \\\"2015-11-10T23:00:00Z\\\",\\n    \\\"TimezoneName\\\": \\\"Australia/Melbourne\\\",\\n\\t\\t\\\"Currency\\\": \\\"USD\\\",\\n\\t\\t\\\"Status\\\": \\\"active\\\"\\n\\t}\\n}' https://api.attendly.net/v2/event\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]","excerpt":"Create an event","slug":"event-create","type":"post","title":"Event create"}

postEvent create

Create an event

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

Name:
required
string
The name of the event
Description:
required
string
The description of the event. This can be HTML
Deadline:
required
datetime
The deadline for buying a ticket
Start:
required
datetime
The start date / time of the event
Stop:
required
datetime
The stop date / time of the event
PresentedBy:
string
Who is this event presented by?
NotAvailableMessage:
string
The message that appears when the event is not available
ThanksMessage:
string
This message appears on the thanks page after the attendee has registered
EmailMessage:
string
This is the message that appears in the confirmation email to the attendee when they register
FooterText:
string
Appears on the footer of the confirmation email
Notification:
booleanfalse
Set to true if you want to receive an email every time an attendee registers
ShowDetails:
booleantrue
Set to false to hide the details of the event on the ticket entry page
ShowComments:
booleanfalse
Set to true to allow comments
ShowSocialMedia:
booleantrue
Show social media throughout the register process
ShowDeadline:
booleantrue
Show the ticket deadline
AttachTicket:
booleantrue
Attach a PDF version of the ticket to the confirmation email
ActiveStart:
datetime
Use this to set when the event becomes available
Terms:
string
Extra terms and conditions
PushURL:
string
Set this to a URL to receive push notifications (JSON) for events like when an attendee registers etc.
Subdomain:
string
The default subdomain to use for the registration URL
ReturnURL:
string
Set this to a URL if you want the attendee to be redirected at the end of the registration process
Hashtag:
string
Set to a twitter hashtag you would like to associate with the event
Currency:
string
AUD, USD, EUR, GBP etc.
Password:
string
Set a password to access the event
Status:
required
stringactive
Set to 'draft' to disable the event

Result Format


Documentation

[block:code] { "codes": [ { "code": "curl -X POST -u \"testuser:moy1zZCscHpx7ei8CzNA\" -H \"Cache-Control: no-cache\" -d '{\n\t\"Event\": {\n\t\t\"Name\": \"Test Active Event\",\n\t\t\"Description\": \"<p>This is just a test event. Note <strong>HTML</strong></p>\",\n\t\t\"Deadline\": \"2015-11-10T23:00:00Z\",\n\t\t\"Start\": \"2015-11-10T23:00:00Z\",\n\t\t\"Stop\": \"2015-11-10T23:00:00Z\",\n \"TimezoneName\": \"Australia/Melbourne\",\n\t\t\"Currency\": \"USD\",\n\t\t\"Status\": \"active\"\n\t}\n}' https://api.attendly.net/v2/event", "language": "curl" } ] } [/block]