Sponsor banner ads

Sponsor banner 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-banner-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-banner-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-banner-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-banner-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-banner-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-banner-ad"
  }
}

Illustrative, with no additional response fields selected.

POSTCreate a record

/api/core/organizations/123/events/456/sponsor-banner-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-banner-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,
  "title": "Example Ltd",
  "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-banner-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-banner-ads/9501

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-banner-ads/9501' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "title": "Example Ltd — visit booth 12",
  "position": 2,
  "archived": false
}'

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

View response structure

{
  "data": {
    "id": "1201",
    "type": "sponsor-banner-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-banner-ads
Methods: GET collection/record, POST, PATCH. There is no DELETE operation; use archived on PATCH.

Fields, filters and associations

Browse 11 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
title: Scope field: title
position: Scope field: position
image-url: Scope field: image_url
display-count: Scope field: display_count
archived-at: Scope field: deleted_at
created-at: Scope field: created_at
updated-at: Scope field: updated_at
clicks-count: Scope field: clicks_count
clicks-by-day: Scope field: clicks_by_day

Filters: sponsor_id, active.
Association: sponsor, linkage only.
Row restriction: by the sponsor association.

GET .../sponsor-banner-ads?sponsor_id=103705&active=true

POST requires sponsor_id; it also accepts title, position, and image.

{
  "sponsor_id": 103705,
  "title": "Example Ltd",
  "position": 1,
  "image": "data:image/png;base64,..."
}

PATCH accepts title, position, image, and archived. An empty image value removes the image. Sponsor restrictions apply to reads and writes.