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

Sponsor ads

Sponsor ads: 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/sponsor-ads

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/sponsor-ads' \
  --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-ad"
    }
  ],
  "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/sponsor-ads/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/sponsor-ads/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-ad"
  }
}

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/sponsor-ads

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/sponsor-ads' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "sponsor_id": 103705,
  "pitch": "Meet the team",
  "image": "data:image/png;base64,<BASE64_DATA>"
}'

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

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

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/sponsor-ads/9401

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/sponsor-ads/9401' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "pitch": "Meet the partnerships team",
  "featured_tile_text": "Book a booth meeting",
  "display_share": 15
}'

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

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

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.

Path: events/{event_id}/sponsor-ads
Methods: GET collection/record, POST, PATCH. There is no DELETE operation; use archived on PATCH.

Fields, filters and associations

Browse 17 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
sponsor-id
Scope field: sponsor_id
pitch
Scope field: pitch
image-url
Scope field: image_url
cover-image-url
Scope field: cover_image_url
featured-tile-image-url
Scope field: featured_tile_image_url
featured-tile-text
Scope field: featured_tile_text
display-share
Scope field: display_share
display-count
Scope field: display_count
collection-display-count
Scope field: collection_display_count
archived-at
Scope field: deleted_at
registrant-id
Scope field: registrant_id
created-at
Scope field: created_at
updated-at
Scope field: updated_at
clicks-count
Scope field: clicks_count
unique-click-registrants-count
Scope field: unique_click_registrants_count
clicks-by-day
Scope field: clicks_by_day
  • Filters: sponsor_id, active, created_from, created_to.
  • Association: sponsor, linkage only.
  • Row restriction: by the sponsor association.
GET .../sponsor-ads?sponsor_id=103705&active=true

POST requires sponsor_id. Other inputs are pitch, featured_tile_text, display_share, image, cover_image, and featured_tile_image.

{
  "sponsor_id": 103705,
  "pitch": "Meet the team",
  "featured_tile_text": "Visit our booth",
  "display_share": 20,
  "image": "data:image/png;base64,..."
}

PATCH accepts pitch, featured_tile_text, display_share, image, cover_image, featured_tile_image, and archived.

{ "archived": true }

Archiving sets archived-at and forces display-share to zero. archived: false restores the record. Image inputs accept base64 data URIs; a blank image value on PATCH removes that image. Sponsor restrictions apply to reads and writes.

Last updated on August 21, 2026