Functions

Create and update functions 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/functions' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "name": "Founder"
}'

201 CreatedIllustrative response

Write-response fields

{
  "data": {
    "id": "1201",
    "type": "function"
  }
}

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}/functions

POST a function

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/functions' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "name": "Founder",
  "position": 10
}'

The response type is function. Useful write-response fields are name, position, and updated_at.

PATCH a function

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/functions/61' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "name": "Founder or co-founder",
  "position": 5
}'

Input reference

2 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-specific function name.

positionScalar number or `null`

POST: Optional
PATCH: Optional

Display order.