Custom lists

Create and update custom lists with complete curl request examples.

Build a request

Example data only. No request is sent.

POST

Choose the destination IDsOrganization IDEvent ID

Start with these fields

name

Event-unique list name.

Add optional fields (17)

Include description

Description.

Include attendance_type

in_person, hybrid, or virtual.

Include profile_badge

Profile badge.

Include display_name

Display name.

Include networking_enabled

Networking setting.

Include lead_scanning_enabled

Lead scanning setting.

Include qr_code_visible

QR setting.

Include meeting_requests_outgoing

none, any, or specific_lists.

Include meeting_requests_incoming

none, any, or specific_lists.

Include max_outgoing_meeting_requests

Limit.

Include max_accepted_meetings

Limit.

Include show_invited_registrants

Visibility setting.

Include show_invites_in_apps

Returned as show-unjoined-registrants-in-apps.

Include show_booking_system_join_url

Returned as show-registration-link.

Include outgoing_target_list_ids

Full replacement when the effective mode is specific_lists.

Include incoming_target_list_ids

Full replacement when the effective mode is specific_lists.

Include registrant_ids

Full membership replacement. [] removes all members but not registrants.

Use the API address and token from your environment. Set up authentication.

curl --fail-with-body --silent --show-error --globoff --max-time 30 --request POST \
  --url "${BRELLA_API_BASE_URL}"'/api/core/organizations/123/events/456/custom-lists' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "name": "VIP guests"
}'

201 CreatedIllustrative response

Write-response fields

{
  "data": {
    "id": "1201",
    "type": "custom-list"
  }
}

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}/custom-lists

POST a custom list

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/custom-lists' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "name": "VIP guests",
  "description": "Guests with VIP access",
  "attendance_type": "in_person",
  "networking_enabled": true,
  "lead_scanning_enabled": true,
  "meeting_requests_outgoing": "specific_lists",
  "outgoing_target_list_ids": [
    410
  ],
  "registrant_ids": [
    1201,
    1202
  ]
}'

The response type is custom-list. Useful write-response fields include name, attendance_type, networking_enabled, registrant_ids, and registrants_count.

PATCH a custom list

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/custom-lists/401' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "name": "VIP and hosted buyers",
  "registrant_ids": [
    1201,
    1202,
    1203
  ]
}'

Input reference

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

nameScalar string

POST: Required by the model
PATCH: Optional

Event-unique list name.

descriptionScalar string or `null`

POST: Optional
PATCH: Optional

Description.

attendance_typeScalar string

POST: Optional
PATCH: Optional

in_person, hybrid, or virtual.

profile_badgeScalar string or `null`

POST: Optional
PATCH: Optional

Profile badge.

display_nameScalar string or `null`

POST: Optional
PATCH: Optional

Display name.

networking_enabledJSON boolean

POST: Optional
PATCH: Optional

Networking setting.

lead_scanning_enabledJSON boolean

POST: Optional
PATCH: Optional

Lead scanning setting.

qr_code_visibleJSON boolean

POST: Optional
PATCH: Optional

QR setting.

meeting_requests_outgoingScalar string

POST: Optional
PATCH: Optional

none, any, or specific_lists.

meeting_requests_incomingScalar string

POST: Optional
PATCH: Optional

none, any, or specific_lists.

max_outgoing_meeting_requestsScalar number or `null`

POST: Optional
PATCH: Optional

Limit.

max_accepted_meetingsScalar number or `null`

POST: Optional
PATCH: Optional

Limit.

show_invited_registrantsJSON boolean

POST: Optional
PATCH: Optional

Visibility setting.

show_invites_in_appsJSON boolean

POST: Optional
PATCH: Optional

Returned as show-unjoined-registrants-in-apps.

show_booking_system_join_urlJSON boolean

POST: Optional
PATCH: Optional

Returned as show-registration-link.

outgoing_target_list_idsArray of scalar IDs

POST: Optional
PATCH: Optional

Full replacement when the effective mode is specific_lists.

incoming_target_list_idsArray of scalar IDs

POST: Optional
PATCH: Optional

Full replacement when the effective mode is specific_lists.

registrant_idsArray of scalar IDs

POST: Optional
PATCH: Optional

Full membership replacement. [] removes all members but not registrants.