Schedule

Update Report

Used to update existing report

patch/schedule/report/{id}

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/schedule/report/{id}
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Path parameters

idstring required

The ID of the report to update

Headers

If-Matchstring

If-Match header according to http/1.1 spec section 14.24

Request body

idstring

The id of this report

created_timeinteger

time the report was created

created_by_idstring

The ID of the user who created this report

last_updated_timeinteger

time the run policy object was last updated

last_updated_by_idstring

The ID of the user who last updated this report

namestring

The display name of the report

descriptionstring

Detailed description of this report

report_type'plan_summary' | 'workspace_summary'

The type of report

medium'email'

The medium we should deliver this report over

organization_idstring

DEPRECATED - use workspace_id instead

workspace_idstring

The workspace id this report relates to

plan_idstring

The plan id this report relates to

journey_idstring

The journey id this report relates to

emailsstring[]

Set of emails to receive the plan report

Response

The updated report

idstring

The id of this report

created_timeinteger

time the report was created

created_by_idstring

The ID of the user who created this report

last_updated_timeinteger

time the run policy object was last updated

last_updated_by_idstring

The ID of the user who last updated this report

namestring

The display name of the report

descriptionstring

Detailed description of this report

report_type'plan_summary' | 'workspace_summary'

The type of report

medium'email'

The medium we should deliver this report over

organization_idstring

DEPRECATED - use workspace_id instead

workspace_idstring

The workspace id this report relates to

plan_idstring

The plan id this report relates to

journey_idstring

The journey id this report relates to

emailsstring[]

Set of emails to receive the plan report

Changes

No recorded changes to this operation across all 37 revisions of this API.