Pathable provides an API that allows a 3rd party ticketing and registration service to “push” new registrations into Pathable, creating new accounts for attendees. When a new account is created, the API will respond with a unique URL the 3rd party can provide to the attendee allowing the attendee to claim his/her account. Typically, the 3rd party will either redirect the attendee to the unique URL as the final step in the registration process, or include the URL in a confirmation e-mail.
Note: by default, Pathable will send an invitation e-mail to attendees who are registered through the API. If you do NOT wil Pathable to send this invitation e-mail (e.g., because you are sending it yourself as described above), visit the Add-Ons section of the Management Dashboard for your event and clear the “Send default invitation to attendees created by the API” checkbox.
To acquire an API token for testing and/or production purposes, please contact info@pathable.com.
URIs for “New Attendee” Call
Production URI: http://api.pathable.com/attendees
Creating a new Attendee
To create a new attendee, simply POST the attendee details to http://api.pathable.com/attendees, including your API Token (e.g., 81dc9bdb52d04dc20036dbd8313ed055).
For example, the HTTP request to create a single attendee would look like this:
POST /attendees Token: 81dc9bdb52d04dc20036dbd8313ed055 Accept: application/xml Content-Type: application/xml <?xml version="1.0" encoding="UTF-8"?> <attendees> <attendee> <email>john@example.com</email> <first_name>John</first_name> <last_name>Smith</last_name> <credentials>PhD</credentials> <job_title></job_title> <category>Press</category> <organization_name>Wallyhood</organization_name> <tags>Artist, Social Media Maven</tags> <description>I like to do interesting things. Lots of interesting things.</description> <professional_url>http://company-name.example.com</professional_url> <personal_url>http://blog-or-website.example.com</personal_url> <facebook_url>http://www.facebook.com/people/John_Smith_Example/</facebook_url> <linkedin_url>http://www.linkedin/in/johnsmithexample</linkedin_url> <authentication_token>919510</authentication_token> </attendee> </attendees>
A similar request made using CURL:
curl -H "Token: 81dc9bdb52d04dc20036dbd8313ed055" -H "Content-type: application/xml" \
-d "<attendees><attendee><email>johnsmith@example.com</email><first_name>John</first_name><last_name>Smith</last_name></attendee></attendees>" \
-X POST http://api.pathable.com/attendees.xml -v
Return response
201 Success:
HTTP/1.1 201 Created
Location: http://example-event.pathable.com/invitations/234900923094239023409
Send the Location header URI to the client, they were added and should use the URI to login to Pathable.
4xx Errors:
HTTP/1.1 400 Bad Request
<error>specific error information included here</error>
Check that the email address provided is valid.
401 - Unauthorized
Check your authentication token and account is valid for the EventID in URI.
417 - Conflict
A user with the email provided is already registered for the event.
