Get Brand Report Email Composition
GET/api/v2/brand-reports/:run/send-composition
The default email for this report: recipients (contacts with the Report Recipient role), CC, subject and body from the brand report template, attachment defaults, the active share link, the summary paragraph, the sender identity and — when sending is not possible — send_blocked_reason (no_report_recipients or status).
reports:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token (scope: reports, permission: brand_reports.send).
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.