Toggle Custom Report Favorite

POST 
/api/v2/custom-reports/:customReport/toggle-favorite

Flip the report's is_favorited flag. Only the owner can favorite a report (403 otherwise). Favorited reports are listed with tab=favorites on List Custom Reports. Returns the updated report.

Required scope: reports:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Authentication: Bearer token (Personal Access Token). Personal access tokens need the reports:write scope.

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

Forbidden

Response Headers

Content-Type

404

Not Found

Response Headers

Content-Type

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

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.