Path Params
The id of the Brella organization you are trying to retrieve data from
The id of the Brella event you are trying to retrieve data from
Header Parameters
Your unique Brella API key
application/vnd.brella.v4+json
curl --location -g --request POST 'https://api.brella.io/api/integration/organizations/{organizationId}/events/{eventId}/invites/' \
--header 'Brella-API-Access-Token: String' \
--header 'Accept: application/vnd.brella.v4+json' \
--header 'Content-Type: application/json'\
--data '{
"event_invite": {
"external_email": "{{random_email}}",
"external_id": "{{random_ext_uuid}}",
"external_first_name": "{{random_first_name}}",
"external_last_name": "{{random_last_name}}",
"seats": 1,
"external_company": "{{random_company}}",
"external_title": "{{random_title}}",
"attendee_group_id": "{{user_group_id}}"
}
}'
{
"data": {
"id": "715060",
"type": "invite",
"attributes": {
"fill-token": "SS4OBI",
"external-email": "krä[email protected]",
"external-id": "12207",
"external-first-name": "Tester2207",
"external-last-name": "McTestersson2207",
"external-company": "Testers 2207",
"external-title": "QA 2207",
"qr-string": "brella_invite_id=715060&brella_invite_token=SS4OBI",
"created-at": "2023-01-29T18:46:29.027Z",
"updated-at": "2023-01-29T18:46:29.078Z",
"attendee-group-name": "Attendees",
"seat-count": "0",
"free-seat-count": "5"
},
"relationships": {
"attendee-group": {
"data": {
"id": "11428",
"type": "attendee-group"
}
},
"seats": {
"data": []
},
"free-seats": {
"data": [
{
"id": "3587578",
"type": "seat"
},
{
"id": "3587577",
"type": "seat"
},
{
"id": "3587576",
"type": "seat"
},
{
"id": "3587575",
"type": "seat"
},
{
"id": "3587574",
"type": "seat"
}
]
},
"question-responses": {
"data": []
}
}
},
"included": [
{
"id": "3587578",
"type": "seat",
"attributes": {
"token": "SS4OBI"
},
"relationships": {
"attendee": {
"data": {}
}
}
},
{
"id": "3587577",
"type": "seat",
"attributes": {
"token": "SS4OBI"
},
"relationships": {
"attendee": {
"data": {}
}
}
},
{
"id": "3587576",
"type": "seat",
"attributes": {
"token": "SS4OBI"
},
"relationships": {
"attendee": {
"data": {}
}
}
},
{
"id": "3587575",
"type": "seat",
"attributes": {
"token": "SS4OBI"
},
"relationships": {
"attendee": {
"data": {}
}
}
},
{
"id": "3587574",
"type": "seat",
"attributes": {
"token": "SS4OBI"
},
"relationships": {
"attendee": {
"data": {}
}
}
},
{
"id": "11428",
"type": "attendee-group",
"attributes": {
"name": "Attendees",
"attendance-type": "virtual",
"default": "true",
"users-are-deletable": "false",
"created-at": "2022-04-13T11:18:36.831Z",
"updated-at": "2022-04-13T11:18:36.831Z",
"attendees-count": {}
},
"relationships": {
"attendees": {
"data": []
}
}
}
]
}
{
"event_invite": {
"external_email": "{{random_email}}",
"external_id": "{{random_ext_uuid}}",
"external_first_name": "{{random_first_name}}",
"external_last_name": "{{random_last_name}}",
"seats": 1,
"external_company": "{{random_company}}",
"external_title": "{{random_title}}",
"attendee_group_id": "{{user_group_id}}"
}
}
01: While multi-seat invites are supported (meaning that the same invite code / URL can be used multiple times to allow different attendees to join the platform), we typically recommend that 1 ticket = 1 invite (so, passing the value 1 to seats), especially if your event uses QR code scanning and / or 3rd party badge printing (eg: xTag, Ticket Butler, Noodle Live etc.)
02: The attendee_group_id attribute is used to map different ticket types / attendee privileges to Brella's user groups, which allow you to control networking privileges, session access privileges and more. You can create as many user groups as needed in the Admin Panel of your event (Event > People > Groups). The attendee_group_id values for the created groups are visible in the Admin Panel as well (see screenshot below). If a value is not specified in the request, the invite will be added to a default user group in Brella (depending on the event type selected).