API reference
Delete a report
DELETE
Deletes the report and its interview. Credits are never refunded: the ledger is append-only, so a deleted report still counts toward the month's usage. A key acts as its owner: members can delete only reports they created (permission_denied otherwise); admins can delete any.
Required scope: reports:write.
Errors
- 400:
unknown_field - 401:
authentication_required,invalid_api_key - 403:
api_access_disabled,insufficient_scope,permission_denied - 404:
report_not_found - 422:
invalid_parameter - 429:
rate_limit_exceeded - 500:
api_error - 503:
maintenance_mode,service_unavailable
ApiKeyheader
AuthorizationBearer <probb_live_<id>_<secret>>id*stringThe report's ID.
Length
1 <= length <= 200Success.
application/json- response
object*stringid*stringdeleted*boolean# Set PROBB_URL and PROBB_API_KEY. Replace any *_VALUE placeholder and any example ID (such as job_example) with a real one.curl --fail-with-body -X DELETE "$PROBB_URL/api/v1/reports/ID_VALUE" \ -H "Authorization: Bearer $PROBB_API_KEY"Example Response
{ "object": "report", "id": "string", "deleted": true}