File a report against a published brief
POST
/v1/p/briefs/{brief_id}/reports
const url = 'http://api.disclosebot.localdev:3000/v1/p/briefs/example/reports';const options = { method: 'POST', headers: {'Content-Type': 'application/vnd.api+json'}, body: '{ "data": { "type": "report", "attributes": { "title": "example", "description": "example", "reporter_email": "example" }, "relationships": { "assets": { "data": [ { "type": "asset", "id": "example" } ] } } } }'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url http://api.disclosebot.localdev:3000/v1/p/briefs/example/reports \ --header 'Content-Type: application/vnd.api+json' \ --data '{ "data": { "type": "report", "attributes": { "title": "example", "description": "example", "reporter_email": "example" }, "relationships": { "assets": { "data": [ { "type": "asset", "id": "example" } ] } } } }'Unauthenticated report intake for the brief embed, the mini-brief, the portal, and the hosted brief page. Rate limited per address (5 a minute, 30 an hour). The acknowledgement carries the shortcode only.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” brief_id
required
string
Brief id or shortcode
Request Body required
Section titled “Request Body required ” Media type application/vnd.api+json
object
data
required
object
type
required
string
attributes
required
object
title
required
string
description
required
string
reporter_email
string
relationships
object
assets
The brief’s assets the report affects
object
data
Array<object>
object
type
required
string
id
required
string
Responses
Section titled “ Responses ”Created
Media type application/vnd.api+json
object
data
required
object
id
required
string
type
required
string
attributes
required
object
shortcode
required
string
Example
{ "data": { "type": "report" }}Not published, or unknown
Validation errors