Custom emails
Custom emails: 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/custom-emails
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/custom-emails' \
--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": "custom-email"
}
],
"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/custom-emails/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/custom-emails/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": "custom-email"
}
}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.
Path: events/{event_id}/custom-emails
Methods: GET collection/record only.
Browse 30 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 name- Scope field:
name subject- Scope field:
subject preview-text- Scope field:
preview_text content- Scope field:
content content-easy-email-json- Scope field:
content_easy_email_json status- Scope field:
status scheduled-at- Scope field:
scheduled_at sent-at- Scope field:
sent_at trigger-on-registrant-update- Scope field:
trigger_on_registrant_update trigger-on-registrant-create- Scope field:
trigger_on_registrant_create trigger-on-registrant-join- Scope field:
trigger_on_registrant_join trigger-on-ticket-purchase-complete- Scope field:
trigger_on_ticket_purchase_complete target-list-ids- Scope field:
target_list_ids created-at- Scope field:
created_at updated-at- Scope field:
updated_at total-count- Scope field:
total_count sending-count- Scope field:
sending_count sent-count- Scope field:
sent_count delivered-count- Scope field:
delivered_count delayed-count- Scope field:
delayed_count hard-bounced-count- Scope field:
hard_bounced_count soft-bounced-count- Scope field:
soft_bounced_count unsubscribed-count- Scope field:
unsubscribed_count spam-count- Scope field:
spam_count rejected-count- Scope field:
rejected_count opened-count- Scope field:
opened_count clicked-count- Scope field:
clicked_count marked-as-spam-count- Scope field:
marked_as_spam_count marked-as-unsubscribed-count- Scope field:
marked_as_unsubscribed_count
- Filters:
status,created_from,created_to,scheduled_from,scheduled_to. - Associations: none.
GET .../custom-emails?status=sent&created_from=2026-08-01T00:00:00ZPOST, PATCH, and DELETE are not available.