Sponsor banner ads

Create and update sponsor banner ads with complete curl request examples.

Build a request

Example data only. No request is sent.

POST

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>"
}'

201 CreatedIllustrative response

Write-response fields

{
  "data": {
    "id": "1201",
    "type": "sponsor-banner-ad"
  }
}

The token scope determines returned fields. This selector illustrates that configuration; it does not change your token or the request.

Collection path: events/{event_id}/sponsor-banner-ads

View the complete cURL example

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",
  "position": 1,
  "image": "data:image/png;base64,<BASE64_DATA>"
}'

The response type is sponsor-banner-ad. Useful write-response fields include sponsor_id, title, position, image_url, deleted_at (returned as archived-at), and updated_at.

View the complete cURL example

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
}'

Use {"archived":true} to archive. Archiving a banner preserves its position.

Input reference

5 inputs. Expand a field for its request type and update behavior. These are the example request keys; your administrator can configure aliases.

sponsor_idScalar ID

POST: Required
PATCH: Ignored

Sponsor must belong to the event and satisfy any sponsor association restriction.

titleScalar string or `null`

POST: Optional
PATCH: Optional

Banner title.

positionScalar number or `null`

POST: Optional
PATCH: Optional

Display order.

imageScalar string

POST: Required by the model
PATCH: Optional

Base64 data URI. A nonblank PATCH value replaces the image. A blank value invokes removal, but the model requires an image, so the save is rejected.

archivedJSON boolean

POST: Ignored
PATCH: Optional

True archives; false restores the record.

Sponsor banner ads

Build a request

POST a sponsor banner ad

PATCH a sponsor banner ad

Input reference