Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send your Edgeful API key in the Authorization header as Bearer <api-key> (for example, Bearer ef_live_<random>).

Body

application/json
conversation_id
string<uuid>
required

the builder conversation the reviewed draft belongs to.

message_id
string<uuid>
required

the successful builder message to publish.

name
string
required

the saved report's name.

Required string length: 1 - 80

Response

Successful Response

definition_id
string
required

saved custom report id.

name
string
required

report name.

status
string
required

saved.

methodology
any | null

the methodology the builder recorded.

assumptions
any | null

the assumptions the builder recorded.

origin
string | null

api for a report saved through the API, else app.

truncated
boolean | null

true when a long methodology or assumptions list was shortened.