Docs API reference
Sign in

Invitations

4 endpoints

GET /{account_slug}/{event_slug}/invitations

list invitations

Returns a paginated list of all invitations for the specified event.

Requires authentication

Path parameters

Name Description
account_slug string Required The unique slug identifier for your Tito account
event_slug string Required The unique slug identifier for the event

Query parameters

Name Description
page integer Page number for pagination (default: 1)

Response fields

Field Description
invitations array

Error responses

  • 401 – unauthorized - no bearer token provided or token is invalid
  • 403 – forbidden - API token does not have access to this event

Example request

curl \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  https://api.staging.pro.tito.io/{account_slug}/{event_slug}/invitations
POST /{account_slug}/{event_slug}/invitations

create invitation

Creates a new invitation for the specified event. Requires an invitation_list_id and ticket_type_id to associate the invitation with.

Requires authentication

Path parameters

Name Description
account_slug string Required The unique slug identifier for your Tito account
event_slug string Required The unique slug identifier for the event

Request body

Field Type Required Description
email string Yes Email address of the invitee
first_name string No First name of the invitee
last_name string No Last name of the invitee
phone_number string No Phone number of the invitee
invitation_list_id integer Yes ID of the invitation list to add this invitation to
ticket_type_id integer Yes ID of the ticket type for this invitation
number_of_guests_allowed integer No Number of additional guests allowed (default: 0, max: 9)

Response fields

Field Description
invitation

Error responses

  • 422 – unprocessable entity - validation errors
  • 401 – unauthorized - no bearer token provided or token is invalid

Example request

curl \
  -X POST \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"email":"jane@example.com","first_name":"Jane","last_name":"Smith","phone_number":"+353879148162","invitation_list_id":456,"ticket_type_id":789,"number_of_guests_allowed":1}' \
  https://api.staging.pro.tito.io/{account_slug}/{event_slug}/invitations
GET /{account_slug}/{event_slug}/invitations/{id}

show invitation

Returns detailed information about a specific invitation.

Requires authentication

Path parameters

Name Description
account_slug string Required The unique slug identifier for your Tito account
event_slug string Required The unique slug identifier for the event
id string Required The unique identifier for the invitation

Response fields

Field Description
invitation

Error responses

  • 401 – unauthorized - no bearer token provided or token is invalid
  • 404 – not found - invitation ID does not exist or is not accessible

Example request

curl \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  https://api.staging.pro.tito.io/{account_slug}/{event_slug}/invitations/123
PATCH /{account_slug}/{event_slug}/invitations/{id}

update invitation

Updates an existing invitation. You can update the invitee details, ticket type, or invitation list.

Requires authentication

Path parameters

Name Description
account_slug string Required The unique slug identifier for your Tito account
event_slug string Required The unique slug identifier for the event
id string Required The unique identifier for the invitation

Request body

Field Type Required Description
email string No Email address of the invitee
first_name string No First name of the invitee
last_name string No Last name of the invitee
phone_number string No Phone number of the invitee
ticket_type_id integer No ID of the ticket type for this invitation
invitation_list_id integer No ID of the invitation list
number_of_guests_allowed integer No Number of additional guests allowed (max: 9)

Response fields

Field Description
invitation

Error responses

  • 422 – unprocessable entity - validation errors
  • 404 – not found - invitation does not exist

Example request

curl \
  -X PATCH \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"email":"updated@example.com","first_name":"Jane","last_name":"Smith","phone_number":"+353879148162","ticket_type_id":789,"invitation_list_id":456,"number_of_guests_allowed":2}' \
  https://api.staging.pro.tito.io/{account_slug}/{event_slug}/invitations/123
← Previous Invitation Lists Next → Orders

API token

Paste your test-mode API key below to personalise the curl examples on this page. This key is stored only in your browser and is never sent to our servers.