Create invite

tab examples url https api brella io api integration organizations organizationid events eventid invites name get new invite method post request pathparameters kind required name organizationid type number children description the id of the brella organization you are trying to retrieve data from kind required name eventid type number children description the id of the brella event you are trying to retrieve data from queryparameters headerparameters kind required name brella api access token type string children description your unique brella api key kind required name accept type string children description application vnd brella v4 json kind required name content type type string children description application json bodydataparameters formdataparameters results languages id psobomoj9uo00ibrqhmgp code n n data n id 3831783 n type invite n attributes n fill token ychoxl n external email test invites brella io n external id 123test456 n external first name test n external last name invites n external company brella n external title test event n qr string brella invite id 3831783 brella invite token ychoxl n created at 2024 12 27t03 07 08 985z n updated at 2024 12 27t03 07 09 906z n attendee group name attendees in person n seat count 1 n free seat count 1 n n relationships n event n data n id 8333 n type event n n n attendee group n data n id 23496 n type attendee group n n n ticket purchase n data n id a282fe96 28cb 457a 896d 0ee54bac2752 n type ticket purchase n n n persona n data n id 5338 n type persona n n n function n data n id 7119 n type function n n n industry n data n id 9323 n type industry n n n seats n data n n id 5215633 n type seat n n n n free seats n data n n id 5215633 n type seat n n n n question responses n data n n custom fields n data n n selected interests n data n n id 12392628 n type selected interest n n n id 12392632 n type selected interest n n n id 12392634 n type selected interest n n n id 12392629 n type selected interest n n n id 12392635 n type selected interest n n n id 12392636 n type selected interest n n n id 12392630 n type selected interest n n n id 12392633 n type selected interest n n n id 12392637 n type selected interest n n n id 12392638 n type selected interest n n n id 12392631 n type selected interest n n n id 12392640 n type selected interest n n n id 12392639 n type selected interest n n n id 12392641 n type selected interest n n n id 12392642 n type selected interest n n n n n n included n n id 5215633 n type seat n attributes n token ychoxl n n relationships n attendee n data null n n n n n id 23496 n type attendee group n attributes n name attendees in person n display name attendees vip n attendance type in person n default true n users are deletable true n created at 2024 08 13t07 24 31 680z n updated at 2024 08 13t07 34 13 099z n attendee count 1 n attendees count 1 n n n n id 8333 n type event n attributes n id 8333 n name swoogo test n location n address n start date 2028 08 16 n end date 2028 08 18 n past false n table nickname table n infoarea photo url null n cover photo url null n logo large url null n logo small url null n uses interests true n uses timeslots true n uses tables true n uses sponsors true n uses speakers true n event type hybrid n uses stream link true n uses meeting slots true n uses event chat true n uses timeslot chat false n uses wizard false n uses sponsor booth links false n uses ticketing false n uses checkout true n uses invoicing false n uses rsvp overlapping true n industry accounting n city null n country united states n region null n created at 2024 08 13t07 24 31 590z n updated at 2024 12 05t09 28 57 659z n content null n sponsors name partners n primary color null n secondary color null n intent pair ids null n uses reception page false n launches at null n start time utc 2028 08 16t07 00 00 000z n end time utc 2028 08 19t06 59 59 999z n chat channel id event 8333 n slug swoogotest n time zone america phoenix n n relationships n tickets n data n n attendee groups n data n n id 23495 n type attendee group n n n id 23496 n type attendee group n n n id 23497 n type attendee group n n n id 23498 n type attendee group n n n id 23499 n type attendee group n n n id 23500 n type attendee group n n n id 24104 n type attendee group n n n id 24105 n type attendee group n n n id 24106 n type attendee group n n n id 24107 n type attendee group n n n id 24108 n type attendee group n n n id 24839 n type attendee group n n n n questions n data n n n n n id a282fe96 28cb 457a 896d 0ee54bac2752 n type ticket purchase n attributes n purchasers email n first name test n last name invites n status completed n created at 2024 12 27t03 07 09 819z n updated at 2024 12 27t03 07 09 963z n purchase completed at 2024 12 27t03 07 09 956z n purchase type checkout n purchasers phone null n tax id type null n tax id null n address line1 null n address line2 null n address postal code null n address city null n address state null n address country code null n stripe session id null n stripe error null n created from integration n n relationships n event n data n id 8333 n type event n n n n n n id 5338 n type persona n attributes n name researcher n position 1 n n n n id 7119 n type function n attributes n name development engineering n position 1 n n n n id 9323 n type industry n attributes n name health and wellness n position 35 n n n n id 723210 n type interest n attributes n name smart contract n position 6 n event id 8333 n n relationships n children n data n n intent pairs n data n n id 1 n type intent pair n n n id 2 n type intent pair n n n id 4 n type intent pair n n n id 3 n type intent pair n n n n n n n id 1 n type intent n attributes n selection label network about this n match label networker n statistics label network n profile label networking about n position 1 n n relationships n pair n data n id 1 n type intent n n n n n n id 12392628 n type selected interest n relationships n selector n data n id 3831783 n type invite n n n interest n data n id 723210 n type interest n n n intent n data n id 1 n type intent n n n n n n id 723211 n type interest n attributes n name my second interest n position 7 n event id 8333 n n relationships n children n data n n intent pairs n data n n id 1 n type intent pair n n n id 3 n type intent pair n n n n n n n id 12392632 n type selected interest n relationships n selector n data n id 3831783 n type invite n n n interest n data n id 723211 n type interest n n n intent n data n id 1 n type intent n n n n n n id 723212 n type interest n attributes n name oooh another interest n position 8 n event id 8333 n n relationships n children n data n n intent pairs n data n n id 1 n type intent pair n n n id 2 n type intent pair n n n id 4 n type intent pair n n n id 3 n type intent pair n n n id 5 n type intent pair n n n n n n n id 12392634 n type selected interest n relationships n selector n data n id 3831783 n type invite n n n interest n data n id 723212 n type interest n n n intent n data n id 1 n type intent n n n n n n id 2 n type intent n attributes n selection label explore getting or buying n match label prospect n statistics label buy explore n profile label exploring getting or buying n position 2 n n relationships n pair n data n id 3 n type intent n n n n n n id 12392629 n type selected interest n relationships n selector n data n id 3831783 n type invite n n n interest n data n id 723210 n type interest n n n intent n data n id 2 n type intent n n n n n n id 12392635 n type selected interest n relationships n selector n data n id 3831783 n type invite n n n interest n data n id 723212 n type interest n n n intent n data n id 2 n type intent n n n n n n id 3 n type intent n attributes n selection label offer or sell this n match label representative n statistics label sell offer n profile label offering or selling n position 3 n n relationships n pair n data n id 2 n type intent n n n n n n id 12392636 n type selected interest n relationships n selector n data n id 3831783 n type invite n n n interest n data n id 723212 n type interest n n n intent n data n id 3 n type intent n n n n n n id 4 n type intent n attributes n selection label get a job in this n match label job seeker n statistics label get a job n profile label seeking a job in n position 4 n n relationships n pair n data n id 5 n type intent n n n n n n id 12392630 n type selected interest n relationships n selector n data n id 3831783 n type invite n n n interest n data n id 723210 n type interest n n n intent n data n id 4 n type intent n n n n n n id 12392633 n type selected interest n relationships n selector n data n id 3831783 n type invite n n n interest n data n id 723211 n type interest n n n intent n data n id 4 n type intent n n n n n n id 12392637 n type selected interest n relationships n selector n data n id 3831783 n type invite n n n interest n data n id 723212 n type interest n n n intent n data n id 4 n type intent n n n n n n id 5 n type intent n attributes n selection label offer a job in this n match label recruiter n statistics label hire someone n profile label offering a job in n position 5 n n relationships n pair n data n id 4 n type intent n n n n n n id 12392638 n type selected interest n relationships n selector n data n id 3831783 n type invite n n n interest n data n id 723212 n type interest n n n intent n data n id 5 n type intent n n n n n n id 6 n type intent n attributes n selection label get investment in this n match label investee n statistics label get investment n profile label seeking investment for n position 7 n n relationships n pair n data n id 7 n type intent n n n n n n id 12392631 n type selected interest n relationships n selector n data n id 3831783 n type invite n n n interest n data n id 723210 n type interest n n n intent n data n id 6 n type intent n n n n n n id 12392640 n type selected interest n relationships n selector n data n id 3831783 n type invite n n n interest n data n id 723212 n type interest n n n intent n data n id 6 n type intent n n n n n n id 7 n type intent n attributes n selection label invest in this n match label investor n statistics label invest in it n profile label investing in n position 6 n n relationships n pair n data n id 6 n type intent n n n n n n id 12392639 n type selected interest n relationships n selector n data n id 3831783 n type invite n n n interest n data n id 723212 n type interest n n n intent n data n id 7 n type intent n n n n n n id 8 n type intent n attributes n selection label find a mentor n match label mentee n statistics label find a mentor n profile label looking for a mentor in n position 8 n n relationships n pair n data n id 9 n type intent n n n n n n id 12392641 n type selected interest n relationships n selector n data n id 3831783 n type invite n n n interest n data n id 723212 n type interest n n n intent n data n id 8 n type intent n n n n n n id 9 n type intent n attributes n selection label be a mentor n match label mentor n statistics label be a mentor n profile label mentoring in n position 9 n n relationships n pair n data n id 8 n type intent n n n n n n id 12392642 n type selected interest n relationships n selector n data n id 3831783 n type invite n n n interest n data n id 723212 n type interest n n n intent n data n id 9 n type intent n n n n n n n language 200 customlabel selectedlanguageid psobomoj9uo00ibrqhmgp examples languages id ovebwgmczitmebch0mkn code curl location g request post https api brella io api integration organizations organizationid events eventid invites n header brella api access token string n header accept application vnd brella v4 json n header content type application json n data n event invite n external email random email n external id random ext uuid n external first name random first name n external last name random last name n seats 1 n external company random company n external title random title n external qr string random qr strings n attendee group id user group id n persona researcher n industry health and wellness n function development engineering n custom fields attributes n n key random key 1 n value random value 1 n n n key random key 2 n value random value 2 n n n interest categories n n name a mm category n interests n n name my first interest n intent ids 1 2 4 6 n n n name my second interest n intent ids 1 4 n n n name oooh another interest n n n n n n import interest selections true n import identity selections true n language curl customlabel selectedlanguageid ovebwgmczitmebch0mkn description create a new invite in an event currentnewparameter label body parameter value bodydataparameters request body 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) 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 04 custom fields attributes in order to pass this value through the api, you first need to create the custom field under custom content > custom fields the field name can be any values that is easy for you to recognize the field key will be the parameters in your api body request for now, the custom field can only be assigned to the invites 05 external qr strings external qr string this field allows you to pass a custom qr code string from a third party platform to brella once this value is sent via the api, the brella app will display this external qr code instead of the default brella qr code brella will also use this external qr code for lead scanning as well this feature is especially helpful if your ticketing or onsite providers (e g swoogo, bizzabo, etc ) already generate a qr code you can pass that same qr code to brella using the external qr string field this ensures that the same qr code is used across all platforms, such as check ins, badge printing, lead retrieval, etc