Create ReportSubscription

POST

api

sys

reportsubscriptions

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/reportsubscriptions \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "Recipients": "<string>",
  "Frequency": 123,
  "DayOfWeek": 123,
  "DayOfMonth": 123,
  "HourOfDay": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/reportsubscriptions"

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "Recipients": "<string>",
    "Frequency": 123,
    "DayOfWeek": 123,
    "DayOfMonth": 123,
    "HourOfDay": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    Name: '<string>',
    Recipients: '<string>',
    Frequency: 123,
    DayOfWeek: 123,
    DayOfMonth: 123,
    HourOfDay: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/reportsubscriptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

A scheduled email delivery of a saved report or dashboard: the data is attached as CSV, the body carries an AI summary and a link to open it in the dashboard. Use report_definition_list / report_dashboard_list to find the report or dashboard to schedule.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the ReportSubscription-Create role.

Request Body

Required Fields

integer

required

ID of the business the schedule belongs to.

string

required

Name of the schedule, e.g. Weekly revenue to finance.

string

required

Email addresses separated by commas or semicolons.

integer

required

Daily, Weekly or Monthly.

integer

required

Weekly schedules: 1 = Monday … 7 = Sunday.

integer

required

Monthly schedules: day of the month (1-28).

integer

required

Hour of the day to send (0-23) in the business time zone.

Optional Fields

integer

Saved report to send (exactly one of ReportDefinitionId, ReportDashboardId, TemplateKey or DashboardTemplateKey).

integer

Saved dashboard to send: every report tile is attached as CSV (set either ReportDefinitionId or ReportDashboardId).

string

Built-in report template to send (key from report_templates), instead of a saved report.

string

Built-in dashboard template to send (key from report_templates kind=dashboard), instead of a saved dashboard.

string

Optional email subject; defaults to the report or dashboard name.

boolean

Attach the report data as CSV files.

boolean

Include an AI-written summary of the results in the email body.

string

Optional JSON: for reports an array of prompt filter overrides [{field, op, value}], for dashboards an object of parameter values keyed by parameter id.

boolean

Paused schedules are kept but not sent.

integer

User who created the schedule; reports run with this user’s permissions (set automatically).

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/sys/reportsubscriptions" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "Recipients": "",
    "Frequency": 0,
    "DayOfWeek": 0,
    "DayOfMonth": 0,
    "HourOfDay": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/reportsubscriptions',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Name: '',
      Recipients: '',
      Frequency: 0,
      DayOfWeek: 0,
      DayOfMonth: 0,
      HourOfDay: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/sys/reportsubscriptions',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'Recipients': '',
        'Frequency': 0,
        'DayOfWeek': 0,
        'DayOfMonth': 0,
        'HourOfDay': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the reportsubscription was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "ReportSubscription was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "[email protected]",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}

Create ReportSubscription

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/reportsubscriptions \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "Recipients": "<string>",
  "Frequency": 123,
  "DayOfWeek": 123,
  "DayOfMonth": 123,
  "HourOfDay": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/reportsubscriptions"

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "Recipients": "<string>",
    "Frequency": 123,
    "DayOfWeek": 123,
    "DayOfMonth": 123,
    "HourOfDay": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    BusinessId: 123,
    Name: '<string>',
    Recipients: '<string>',
    Frequency: 123,
    DayOfWeek: 123,
    DayOfMonth: 123,
    HourOfDay: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/reportsubscriptions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400