Before you write

Set up your token permissions and shell variables for the write examples.

An organization administrator must configure a scope for the resource in Brella’s Admin Panel. For each example in this cookbook, the scope must:

1. be enabled;
2. cover the organization and, for event-level resources, the event in the URL;
3. have Write permission;
4. enable the relevant create or update action;
5. select every writable field used by the request; and
6. select any fields that should be returned under Write response fields.

The Admin Panel obtains these options from Core API introspection. It cannot grant an action or field that the registered wrapper does not expose.

The examples assume that each selected writable field uses its normal request key: for example, the scope maps request parameter first_name to writable field first_name. A scope may map a different request parameter to the same field. If your administrator has done that, use the configured parameter name instead of the one shown here.

Set these shell variables once before using the curl examples:

export BRELLA_API_BASE_URL="https://api.brella.io"
export BRELLA_ORGANIZATION_ID="30"
export BRELLA_EVENT_ID="319986"
export BRELLA_API_ACCESS_TOKEN="YOUR_TOKEN"

Use the sandbox hostname supplied by Brella when testing against a sandbox. Replace all example resource IDs and example values with records that belong to your organization and event.