Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsEnd Report Schedule
Search the full API reference Esc to close

End Report Schedule

Reports · REST API reference

Get support
DELETE/v1/report-schedules/{schedule_id}
End a schedule: its soft delete and `report_schedule.ended`; 200 with the ended schedule. 404 for another org's id or an ended one; the same people as an edit may end one (framework 12.4).

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request example

Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.

cURL
curl --request DELETE \
  --url 'https://api.staging.facily.ai/v1/report-schedules/<SCHEDULE_ID>' \
  --header "Authorization: Bearer $FACILY_API_KEY"
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

schedule_idpath · stringrequired

The report schedule's id.

Format: uuid

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

200Successful Response
JSON · generated example
{
  "data": {
    "cadence": "daily",
    "can_manage": false,
    "can_take_over": false,
    "consecutive_failures": 0,
    "created_at": "2026-10-29T12:00:00Z",
    "definition_key": "string",
    "format": "csv",
    "id": "00000000-0000-4000-8000-000000000001",
    "local_time": "string",
    "needs_owner": false,
    "next_run_at": "2026-10-29T12:00:00Z",
    "next_run_local": "string",
    "owner": {
      "display_name": "string",
      "id": "00000000-0000-4000-8000-000000000001"
    },
    "starts_on": "2026-10-29",
    "status": "active",
    "timezone": "string",
    "updated_at": "2026-10-29T12:00:00Z",
    "view_key": "string"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataReportScheduleResponserequired

One schedule (framework 12.1): what it runs, when, for whom, and what the caller may do with it.

Show data schema
cadencestringrequired

How often it runs.

Values: "daily", "weekly", "monthly", "quarterly"

can_managebooleanrequired

Whether the caller may edit, pause, resume or end it.

can_take_overbooleanrequired

Whether the caller may take it over.

card_namestring | null

The report's name; null for a report retired since.

Show card_name schema
string | null

The report's name; null for a report retired since.

Variant 1: string
string
Variant 2: null
null
consecutive_failuresintegerrequired

Failed runs in a row.

created_atstringrequired

When the schedule was created.

Format: date-time

definition_keystringrequired

The report's key.

facility_idstring | null

The facility; null for all facilities.

Format: uuid

Show facility_id schema
string | null

The facility; null for all facilities.

Variant 1: string
string
Variant 2: null
null
facility_namestring | null

The facility's name; null for all facilities.

Show facility_name schema
string | null

The facility's name; null for all facilities.

Variant 1: string
string
Variant 2: null
null
filtersobject

The view's filters, as stored.

formatstringrequired

The file the emailed link opens first.

Values: "csv", "xlsx", "pdf", "zip"

idstringrequired

The schedule's id.

Format: uuid

last_runReportScheduleLastRunResponse | null

The most recent run; null before the first.

Show last_run schema
ReportScheduleLastRunResponse | null

The most recent run; null before the first.

Variant 1: ReportScheduleLastRunResponse
completed_atstring | null

When the run completed or failed.

Format: date-time

Show completed_at schema
string | null

When the run completed or failed.

Variant 1: string
Variant 2: null
error_messagestring | null

Why the run failed, for the reader. It holds no value.

Show error_message schema
string | null

Why the run failed, for the reader. It holds no value.

Variant 1: string
Variant 2: null
idstringrequired

The run's id.

Format: uuid

statusstringrequired

`queued`, `running`, `completed` or `failed`.

Values: "queued", "running", "completed", "failed"

Variant 2: null
null
local_timestringrequired

`HH:MM` in `timezone`.

month_dayinteger | null

1 to 28, or -1 for the last day, for a monthly or quarterly one.

Show month_day schema
integer | null

1 to 28, or -1 for the last day, for a monthly or quarterly one.

Variant 1: integer
integer
Variant 2: null
null
needs_ownerbooleanrequired

True when the owner can no longer run this report here: a member may take it over.

next_run_atstringrequired

The next run's moment, in UTC.

Format: date-time

next_run_localstringrequired

The next run's date and time in `timezone`, ISO with no offset (`2026-11-02T06:00:00`).

notesstring | null

Notes for the members.

Show notes schema
string | null

Notes for the members.

Variant 1: string
string
Variant 2: null
null
ownerReportMemberResponserequired

A member of the organization as the schedule routes name one: id and display name only, never an address or a role (framework 12.1).

Show owner schema
display_namestringrequired

The member's name, as the team list shows it.

idstringrequired

The member's user id.

Format: uuid

pause_reasonstring | null

Why a paused schedule is paused: `manual`, `no_recipients` (no recipient could receive it), `report_locked` (the report became unavailable) or `failing` (three failed runs in a row).

Values: "manual", "no_recipients", "report_locked", "failing"

Show pause_reason schema
string | null

Why a paused schedule is paused: `manual`, `no_recipients` (no recipient could receive it), `report_locked` (the report became unavailable) or `failing` (three failed runs in a row).

Variant 1: string
string

Values: "manual", "no_recipients", "report_locked", "failing"

Variant 2: null
null
range_rulestring | null

The named range each run reports; null for a view that takes no dates.

Show range_rule schema
string | null

The named range each run reports; null for a view that takes no dates.

Variant 1: string
string
Variant 2: null
null
recipientsReportMemberResponse[]

Who receives the link.

Show recipients schema
display_namestringrequired

The member's name, as the team list shows it.

idstringrequired

The member's user id.

Format: uuid

starts_onstringrequired

No run happens before this day.

Format: date

statusstringrequired

`active` or `paused`.

Values: "active", "paused"

timezonestringrequired

The schedule's timezone: its facility's, or for all the first facility's.

updated_atstringrequired

When it last changed.

Format: date-time

view_keystringrequired

The view's key.

view_namestring | null

The view's name; null for a view retired since.

Show view_name schema
string | null

The view's name; null for a view retired since.

Variant 1: string
string
Variant 2: null
null
weekdayinteger | null

1 (Monday) to 7 (Sunday) for a weekly schedule.

Show weekday schema
integer | null

1 (Monday) to 7 (Sunday) for a weekly schedule.

Variant 1: integer
integer
Variant 2: null
null
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Continue exploringAll reports operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

End Report Schedule | Facily Developers