Abuse reports

Create and update abuse reports 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/abuse-reports' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "reported_registrant_id": 1201,
  "reporting_registrant_id": 1202,
  "reason": "Unwanted contact"
}'

201 CreatedIllustrative response

Write-response fields

{
  "data": {
    "id": "1201",
    "type": "abuse-report"
  }
}

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}/abuse-reports

POST an abuse report

Repeated reporting of the same user is handled by Brella’s report service and may update the existing parent report rather than creating an unrelated duplicate.

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/abuse-reports' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "reported_registrant_id": 1201,
  "reporting_registrant_id": 1202,
  "reason": "Unwanted contact"
}'

The response type is abuse-report. Useful write-response fields include reported_registrant_id, report_count, and latest_report_at.

PATCH an abuse report

The status update is applied to all report instances represented by the parent abuse report.

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/abuse-reports/7001' \
  --header "Accept: application/vnd.brella.v4+json" \
  --header "Brella-API-Access-Token: ${BRELLA_API_ACCESS_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-raw '{
  "status": "solved"
}'

Input reference

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

reported_registrant_idScalar ID

POST: Required
PATCH: Ignored

Reported registrant must belong to the event and have a Brella user.

reporting_registrant_idScalar ID

POST: Required
PATCH: Ignored

Reporting registrant must belong to the event and have a Brella user.

reasonScalar string or `null`

POST: Optional
PATCH: Ignored

Reason recorded on the report instance.

statusScalar string

POST: Ignored
PATCH: Required for a meaningful update

PATCH accepts only archived or solved.