Sponsor ads

Create and update sponsor 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-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>"
}'

201 CreatedIllustrative response

Write-response fields

{
  "data": {
    "id": "1201",
    "type": "sponsor-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-ads

Replace <BASE64_DATA> with the actual base64 payload, without angle brackets.

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-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",
  "featured_tile_text": "Visit our booth",
  "display_share": 20,
  "image": "data:image/png;base64,<BASE64_DATA>"
}'

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

The sponsor cannot be changed after creation. This example updates display content:

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

Archive through PATCH because this resource has no delete mutation:

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-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 '{
  "archived": true
}'

Input reference

8 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.

pitchScalar string or `null`

POST: Optional
PATCH: Optional

Ad pitch.

featured_tile_textScalar string or `null`

POST: Optional
PATCH: Optional

Featured-tile text.

display_shareScalar number

POST: Optional; defaults to `0`
PATCH: Optional

Event-level display-share validation applies.

imageScalar string

POST: Optional
PATCH: Optional

Base64 data URI. Blank on PATCH removes the image.

cover_imageScalar string

POST: Optional
PATCH: Optional

Base64 data URI. Blank on PATCH removes the image.

featured_tile_imageScalar string

POST: Optional
PATCH: Optional

Base64 data URI. Blank on PATCH removes the image.

archivedJSON boolean

POST: Ignored
PATCH: Optional

True archives and sets display share to zero; false restores the record.

Sponsor ads

Build a request

POST a sponsor ad

PATCH a sponsor ad

Input reference