Skip to content
Core API
Esc
↑↓navigate↵open⌘Jpreview
On this page

Sponsors

Sponsors: available fields, filters, associations, and API operations.

Operations

Event-level resource. Every operation requires an enabled Core API scope for this resource and access to the URL context.

GETList records

/api/core/organizations/123/events/456/sponsors

Permission: Read access. Readable fields, query filters and related objects must be selected in the scope.

curl --fail-with-body --silent --show-error --globoff --max-time 30 --request GET \
  --url "${BRELLA_API_BASE_URL}"'/api/core/organizations/123/events/456/sponsors' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}"

Response: 200 OK. A JSON:API data array and pagination metadata. Default page size 30; maximum 100.

View response structure
{
  "data": [
    {
      "id": "1201",
      "type": "sponsor"
    }
  ],
  "meta": {
    "total_count": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

Illustrative, with no additional response fields selected.

Errors: 400 for invalid parameter shapes; 403 for a missing/expired token or disallowed operation; 404 when the URL context, record or a referenced record is inaccessible; 429 for rate limits. Troubleshooting and retry guidance.

GETGet a record

/api/core/organizations/123/events/456/sponsors/1201

Permission: Read access. Readable fields, query filters and related objects must be selected in the scope.

curl --fail-with-body --silent --show-error --globoff --max-time 30 --request GET \
  --url "${BRELLA_API_BASE_URL}"'/api/core/organizations/123/events/456/sponsors/1201' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}"

Response: 200 OK. A JSON:API data object; fields depend on the token scope.

View response structure
{
  "data": {
    "id": "1201",
    "type": "sponsor"
  }
}

Illustrative, with no additional response fields selected.

Errors: 400 for invalid parameter shapes; 403 for a missing/expired token or disallowed operation; 404 when the URL context, record or a referenced record is inaccessible; 429 for rate limits. Troubleshooting and retry guidance.

POSTCreate a record

/api/core/organizations/123/events/456/sponsors

Permission: Write access with the create action. Every request key must map to an allowed writable field; unconfigured inputs are ignored.

curl --fail-with-body --silent --show-error --globoff --max-time 30 --request POST \
  --url "${BRELLA_API_BASE_URL}"'/api/core/organizations/123/events/456/sponsors' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "name": "Example Ltd",
  "category_id": 51,
  "level": "large"
}'

Response: 201 Created. Save data.id for later requests. Attributes come from Write-response fields.

View response structure
{
  "data": {
    "id": "1201",
    "type": "sponsor"
  }
}

Illustrative, with no additional response fields selected.

Errors: 400 for invalid parameter shapes; 403 for a missing/expired token or disallowed operation; 404 when the URL context, record or a referenced record is inaccessible; 422 for validation or business rules; 429 for rate limits. Troubleshooting and retry guidance.

PATCHUpdate a record

/api/core/organizations/123/events/456/sponsors/103705

Permission: Write access with the update action. Every request key must map to an allowed writable field; unconfigured inputs are ignored.

curl --fail-with-body --silent --show-error --globoff --max-time 30 --request PATCH \
  --url "${BRELLA_API_BASE_URL}"'/api/core/organizations/123/events/456/sponsors/103705' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "subtitle": "Partnership platform",
  "cta_text": "Book a demo",
  "company_domains": [
    "example.com",
    "example.org"
  ],
  "products": [
    {
      "title": "Example Platform",
      "description": "Updated product overview",
      "url": "https://example.com/platform"
    },
    {
      "title": "Example Analytics",
      "description": "Sponsor analytics add-on",
      "url": "https://example.com/analytics"
    }
  ]
}'

Response: 200 OK. Attributes come from Write-response fields; these can differ from readable fields.

View response structure
{
  "data": {
    "id": "1201",
    "type": "sponsor"
  }
}

Illustrative, with no additional response fields selected.

Errors: 400 for invalid parameter shapes; 403 for a missing/expired token or disallowed operation; 404 when the URL context, record or a referenced record is inaccessible; 422 for validation or business rules; 429 for rate limits. Troubleshooting and retry guidance.

PATCH changes supplied fields. Collection inputs can replace existing values; read the input notes before sending arrays.

DELETEDelete a record

/api/core/organizations/123/events/456/sponsors/1201

Permission: Write access with the delete action.

curl --fail-with-body --silent --show-error --globoff --max-time 30 --request DELETE \
  --url "${BRELLA_API_BASE_URL}"'/api/core/organizations/123/events/456/sponsors/1201' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}"

Response: 204 No Content, with an empty response body.

Errors: 400 for invalid parameter shapes; 403 for a missing/expired token or disallowed operation; 404 when the URL context, record or a referenced record is inaccessible; 422 for validation or business rules; 429 for rate limits. Troubleshooting and retry guidance.

Deletion can remove related data or be refused by resource constraints. Read the resource notes and confirm the target before using this operation.

Path: events/{event_id}/sponsors
Methods: GET collection/record, POST, PATCH, DELETE.

Fields, filters and associations

Browse 46 response fields

The scope chooses these response fields. id is always returned. Configuration names and response names can differ.

event-id
Scope field: event_id
category-id
Scope field: category_id
level
Scope field: level
order
Scope field: order
position
Scope field: position
name
Scope field: name
subtitle
Scope field: subtitle
content
Scope field: content
website
Scope field: website
twitter
Scope field: twitter
linkedin
Scope field: linkedin
facebook
Scope field: facebook
instagram
Scope field: instagram
active
Scope field: active
industry
Scope field: industry
external-id
Scope field: external_id
uses-chat
Scope field: uses_chat
state
Scope field: state
uses-analytics
Scope field: uses_analytics
cta-text
Scope field: cta_text
lead-scanning-enabled
Scope field: lead_scanning_enabled
has-automatic-representatives-linking
Scope field: has_automatic_representatives_linking
allows-meet-at-booth
Scope field: allows_meet_at_booth
uses-meet-at-booth
Scope field: uses_meet_at_booth
app-sponsor
Scope field: app_sponsor
app-sponsor-label
Scope field: app_sponsor_label
location-country
Scope field: location_country
location-state
Scope field: location_state
company-domains
Scope field: company_domains
representatives-linking-method
Scope field: representatives_linking_method
meeting-cap
Scope field: meeting_cap
map-link
Scope field: map_link
show-sponsored-session-rsvps
Scope field: show_sponsored_session_rsvps
created-at
Scope field: created_at
updated-at
Scope field: updated_at
logo-url
Scope field: logo_url
cover-image-url
Scope field: cover_image_url
app-sponsor-image-url
Scope field: app_sponsor_image_url
booth-tabs
Scope field: booth_tabs
representatives-count
Scope field: representatives_count
approved-representatives-count
Scope field: approved_representatives_count
representative-ids
Scope field: representative_ids
lead-count
Scope field: lead_count
main-sponsored-session-count
Scope field: main_sponsored_session_count
track-ids
Scope field: track_ids
leads-by-day
Scope field: leads_by_day
  • Filters: name, external_id, state, category_id, level, main_sponsored_session_id, session_sponsored_session_id.
  • Row restrictions: primary sponsor IDs, field state, or association category. A primary-ID-restricted scope cannot create sponsors.
  • Associations:
    • category: name, level, position, external-id, allows-meet-at-booth, sponsors-count;
    • sponsor_admins → sponsor-admins: email, invitation-used-at;
    • ads: pitch, image-url, cover-image-url, featured-tile-image-url, featured-tile-text, display-share, display-count, collection-display-count, archived-at, registrant-id, clicks-count, unique-click-registrants-count, clicks-by-day, created-at, updated-at;
    • banner_ads → banner-ads: title, position, image-url, sponsor-id, display-count, archived-at, clicks-count, clicks-by-day, created-at, updated-at;
    • products: title, description, position, image-url, url, created-at, updated-at;
    • downloads: title, description, position, attachment-type, attachment-url, file-url, enabled, created-at, updated-at;
    • deck_media → deck-media, plus attachments, tabs, and media: position, body-type, title, url, image-url, mime-type, description, cta-text, created-at, updated-at;
    • session_sponsors → session-sponsorships: timeslot-id, position, label, title, start-time, end-time;
    • locations → singular response booth-location: name, color, location-type;
    • selected_interests → interests: interest-id, interest-name, intent-id, intent-label;
    • custom_fields → custom-fields: definition-key, definition-title, field-type, values.

sponsor_admins is organizer-only and is suppressed for primary-sponsor-restricted scopes even if configured.

GET .../sponsors?state=active&include=category,products,locations,session-sponsors

Writing this resource

Writable fields: category_id, level, position, name, subtitle, content (raw JSON), website, twitter, linkedin, facebook, instagram, active, industry, external_id, uses_chat, state, uses_analytics, cta_text, lead_scanning_enabled, has_automatic_representatives_linking, allows_meet_at_booth, uses_meet_at_booth, app_sponsor, app_sponsor_label, location_country, location_state, company_domains (array), representatives_linking_method, meeting_cap, map_link, show_sponsored_session_rsvps.

Additional inputs: logo, cover_image, app_sponsor_image, custom_fields_attributes (raw JSON), selected_interests (raw JSON), media (raw JSON), products (raw JSON), booth_tabs (raw JSON).

{
  "name": "Example Ltd",
  "category_id": 51,
  "level": "large",
  "active": true,
  "state": "active",
  "website": "https://example.com",
  "company_domains": ["example.com"],
  "products": [
    { "title": "Example Platform", "description": "Product overview", "position": 1 }
  ],
  "booth_tabs": [
    { "key": "overview", "title": "Overview", "position": 1 }
  ]
}

The category must belong to the event; use sponsor categories to read or manage it. Image inputs accept base64 data URIs; a blank image value on PATCH removes the image. products is a full replacement when supplied. Booth tabs expose only key, title, and position. Sponsor content is sanitized before storage.

Last updated on October 9, 2026