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
template_type
enum<string>
required

report, wip (What's in Play) or screener.

Available options:
report,
wip,
screener
name
string | null

template name, trimmed and unique per type ignoring case; required to create.

Required string length: 1 - 255
configuration
Configuration · object | null

the template's configuration, in the shape the save template operation gives for its type; required to create.

parent_report
string | null

report templates only: the report page's slug from the report catalog.

Required string length: 1 - 80
sub_report
string | null

report templates only: the page's sub-report slug.

Required string length: 1 - 80
id
integer | null

id of the template to update; omit to create one.

Required range: -2147483648 <= x <= 2147483647

Response

Successful Response

status
string
required

created, updated or unchanged.

template
TemplateEntry · object
required

the saved template.

previous
TemplateEntry · object | null
required

the template before an update, for undo; null on create.

changed
TemplatesChanged · object
required

what this write changed.