Invites

Create invite

2min
Create a new invite in an event
POST
Request
Path Params
{organizationId}
required
Number
The id of the Brella organization you are trying to retrieve data from
{eventId}
required
Number
The id of the Brella event you are trying to retrieve data from
Header Parameters
Brella-API-Access-Token
required
String
Your unique Brella API key
Accept
required
String
application/vnd.brella.v4+json
Content-Type
required
String
application/json
Curl
Responses
200


REQUEST BODY

{ "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}}", "persona": "{{random_personna}}", "industry": "{{random_industry}}", "function": "{{random_function}}", "interest_categories": [ { "name": "{{random_category}}", "interests": [ { "name": "{{random_interest}}", "intent_ids": [1,2,4,6] }, { "name": "{{random_interest}}", "intent_ids": [1,4] }, { "name": "{{random_interest}}" } ] } ] }, "import_interest_selections": true, "import_identity_selections": true } }

Required attributes:

  • external_email (String / supports accents and special characters)
  • seats (Number / see notes for more information)
  • import_interest_selections These attributes by default are FALSE. However, if these are not set to TRUE, any interests/ intents and identity data (personas, function, industry) won't get updated or created.
  • import_identity_selections These attributes by default are FALSE. However, if these are not set to TRUE, any interests/ intents and identity data (personas, function, industry) won't get updated or created.
    

Notes:

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).



Document image


03: Matchmaking and Identities Prefilling.

  • There are two attributes, which need to be set to "true":
    • import_interest_selections
    • import_identity_selections
  • If the interests/ identities don't exist in the matchmaking set-up, the API call will create these interests and identities.
  • If you make an API call where the interests array or any of those parameters is empty, it will delete them from the INVITE. It will NEVER DELETE interests or identities from the event itself, since multiple attendees might be using these interests and identity data in the event.
  • If the parameters "interest_categories", "persona", "industry" and "function"are NOT present in the request (i.e. you don't have these attributes at all), they won't be updated.
  • To specify intents for a specific MM interest, you need to use "intent IDs" that correspond to the following intents:
    • 1 = Networking
    • 2,3 = Trading
      • 2 = Exploring Getting or Buying
      • 3 = Offer or Sell this
    • 4,5 = Recruitment
      • 4 = Get a job in this
      • 5 = Offer a job in this
    • 6,7 = Investment
      • 6 = Get investment in this
      • 7 = Invest in this
    • 8,9 = Mentoring
      • 8 = Find a mentor
      • 9 = Be a mentor
  • If you want to include both intents within a pair, you need to add both "intent_ids" in the array.
  • If you don't specify the "intent_ids" array inside the interest object, all intents will get selected by default.



Updated 27 Dec 2024
Did this page help you?
PREVIOUS
Find invite by company name
NEXT
Update Invites
Docs powered by Archbee