post
https://production-api.shoutaboutus.com/api/v1/partner/reports/add
Create a scheduled partner-level email report (activity/response/feed/etc.) for a recipient, scoped to all accounts the partner owns or to a specific list of account companies.
Auth: Partner — authentication; lives under the partner/* group (partner-admin scope, no Hipages gate). The owning company is the auth user's. Each account.* id must sit inside your own account tree, so a partner can only target account companies inside its own company tree. The recipient comes either from an existing user (old_recipient_email) or created fresh from recipient_email + name.
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 are forced to day frequency. |
reportPeriodType | string | yes | day, week, or month. Further constrained by based on reportType. |
all_account | integer | yes | 1 = all accounts the partner owns, 0 = specific accounts. Rule required|nullable|in:0,1. |
account | int[] | required_if all_account=0 | Account company ids; each must be an existing account and pass an ownership check. |
old_recipient_email | string(email) | required_without recipient_email | Existing user's email; report attached to that user. |
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!. On missing company / unknownold_recipient_email, a 400{ status: 'error', response: 'Company not found!' | 'User not found!' }comes back instead.
Errors: 422 on validation failure.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…