API Reference

Edit a partner email report

post
https://production-api.shoutaboutus.com/api/v1/partner/reports/edit

Change a scheduled report's frequency or the accounts it covers. Use this when the team or needs change.

Prerequisites: a Partner bearer token and the report's report_id (from List scheduled reports).

Authentication: Partner token; any other token gets 403. The report and every account must be inside your tree, otherwise 422.

Rate limit: none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
Defaults to 5

The report to change. Must exist and be inside your tree. Sending it is what makes this an edit.

string
enum
required
Defaults to month

How often to send it: day, week or month. It must fit the report's type, as when you scheduled it (for example month for an activity report).

Allowed:
integer
enum
required
Defaults to 0

1 to cover every account under your partner, 0 to cover only the accounts in account.

Allowed:
account
array of integers
Defaults to 5994

Account ids to cover. Required when all_account is 0. Each must exist and be inside your tree. Replaces the accounts the report covered before.

account
Responses

Updated 18 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 18 days ago

Did this page help you?