Share Custom Report

POST 
/api/v2/custom-reports/:customReport/shares

Share a report with a user of your account, or change the permission of an existing share (sharing with the same user again updates it). Only the owner can share (403 otherwise).

Required scope: reports:write

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

Body:

• user_id (integer, required): a user who belongs to this account (see Search Share Recipients); any other id returns 422, and so does your own id
• permission (string, required): view (can see, run, export and duplicate) or edit (can also update and restore versions)

Returns 201 with the share in data.

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

Request

Responses

201

Created

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 — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

Unprocessable Content

Response Headers

Content-Type

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.