Sponsors

Create sponsor

3min

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.



Create a new sponsor 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

{ "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 "content":"{{rich_text_content}}" } }

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 true, automatically links sponsor representatives to this sponsor company, if the company name matches the sponsor name. Leave false to manually select who is linked to this sponsor company.

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.

Updated 05 Aug 2024
Did this page help you?
PREVIOUS
Get sponsor by id
NEXT
Update sponsor
Docs powered by Archbee