Sponsors
Update sponsor
4min
warning! due to a sporadic bug, you should leave at least 0 5 seconds between requests to this endpoint — unless you are explicitly specifying "position" for each sponsor failure to do so may result in some requests failing with a 500 server error this notice will be updated once the bug is fixed request body { "sponsor" { "category id" "{{category id}}", "position" "{{position id}}", "uses chat" true, "uses analytics" true, " lead scanning enabled"\ true, "name" "{{random company name}}", "subtitle" "{{random subtitle}}, "logo" "{{logo url}}", "cover image" "{{cover image url}}", "cta text" "{{some cta text}}", "facebook" "{{facebook page url}}", "twitter" "{{twitter url}}", "linkedin" "{{linkedin url}}", "instagram" "{{instagram url}}", "website" "{{website url}}", "industry" "{{random company}}", " has automatic representatives linking " true, "representatives linking method" " company domain match ", "company domains" \["abc com","xyz io"], "content" "{{rich text content}}" "products" \[ { "title" "{{random product}}", "description" "{{random description}}", "url" "{{random url}}", "image" "{{random image}}" }, { "title" "{{random product}}", "description" "{{random description}}", "url" "{{random url}}", "image" "{{random image}}" } ] } } required attributes category id number / see notes for more information name string / typically the company name notes 01 the lead scanning enabled , uses analytics , uses chat and has automatic representatives linking attributes are of the boolean type, and support the values true / false lead scanning enabled if true, allows any sponsor representatives / attendees linked to this sponsor company to use lead scanning to capture data by scanning qr codes this data will be available to sponsor admins and reps in the sponsor admin panel uses analytics if true, allows sponsor admins assigned to this sponsor company to see traffic analytics data (such as who visited their virtual booth and engaged with their content etc ) uses chat if true, enables a public booth chat for their virtual booth has automatic representatives linking if you'd like to automatically link sponsor representatives to this sponsor company, this needs to be set as true along with the representatives linking method option leave false to manually select who is linked to this sponsor company representatives linking method supports the following values partial company name match links the representatives if the sponsor company name matches most of the content for example, if the sponsor company name is 'abc ltd' and the user's company title is 'abc' or 'abc ltd' partial match will link ✅ exact company name match only links the representatives if the sponsor company name matches exactly this is case sensitive company domain match links the representatives based on the email domains provided for example if sponsor company name is 'abc ltd' and email domain is 'abc com', all users with "abc com" in their email addresses will be linked automatically company domain is an array which supports whatever domains you need to match sponsor reps by (eg if you supply brella io and google ie as company domains — whenever anyone with a abc\@brella io or xyz\@google ie email in their invite joins brella, they will get assigned to that booth ) 02 the cover image and logo attributes allow for automatic uploading of a booth cover image and sponsor logo from web based sources to use this, pass a url leading to a valid image resource (jpg / jpeg / png etc ) as a string 03 the values for the category id attribute can be found in your event's admin panel (sponsors > categories) you can add as many categories as needed in the admin panel categories can't be created via the api just yet this field is mandatory 04 interest categories should include a matchmaking category and the interests if the interests don't exist in the matchmaking set up, the api call will create these interests 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 from the event itself, since multiple attendees/ sponsors might be using these interests and identity data in the event 05 product should be an array each object within the product sarray corresponds to a single sponsor product the name , description , and url are mandatory if you are using the "patch" requests to update the products, this must only be controlled via the api if the sponsors add/ update / delete the products via the brella sponsor panel, these will be overwritten by the apis how updating/ deleting products logic works every time a patch request runs, the entire " products " array is evaluated then, the api will delete or update note that, the "update" also technically works by deleting the old product, and creating a new one with the updated data for example a sponsor has the following products within the "products" array \[product 1, product 2, product 3] a patch request is made to the newly created sponsor, but the products array contains the following products \[product z, product 3] the products for this sponsor will now only contain product z and product 3 product 1 and product 2 will be deleted in reality, as mentioned above, "product 3" is also deleted, but it gets recreated with the patch request (so the actual internal id of product 3 won't be the same)