post
https://production-api.shoutaboutus.com/api/v1/user/reports/add
Add a new recipient to receive an automated account-level email report on a daily/weekly/monthly cadence, scoped to all stores under the account or a specific store list.
Auth: Account — authentication; under the user/* group. Requires the auth user's company to be an account (bundle_id=3), so only an account user is allowed (else 403). Each store_ids.* is checked by an ownership check so only stores in the caller's company tree are accepted; all_store=1 expands.
Rate limit: No rate limit.
Request
- Body:
| Field | Type | Required | Notes |
|---|---|---|---|
reportType | string | yes | One of activity_report, response_report, review_feed, review_feed_star, review_responses, review_site_connections. review_feed/review_feed_star must use day. |
reportPeriodType | string | yes | day, week, or month; constrained. |
all_store | integer | yes | 1 = all stores, 0 = specific stores. Rule required|in:0,1. |
store_ids | int[] | required_if all_store=0 | Store ids; each must be an existing location and pass an ownership check. |
old_recipient_email | string(email) | required_without recipient_email | Existing email; reused (or created from matching user's name) as the recipient. |
recipient_email | string(email) | required_without old_recipient_email | New recipient email. |
recipient_first_name | string(max 100) | required_without old_recipient_email | New recipient first name. |
recipient_last_name | string(max 100) | required_without old_recipient_email | New recipient last name. |
Response — { data. } envelope.
status(string) —success.response(string) — messageReport has been saved successfully!.
Errors: 422 on validation failure.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…