Sharing

Publish / unpublish and set the link audience

Change visibility (private, team, registered, domain, public), public_permission (none, view, comment, edit), show_approved_only (staged publishing: view-only audiences see the last approved revision), and/or allowed_embed_origins (the origins allowed to iframe the report via /embed/{id}; [] or null turns embedding off). domain (anyone signed in with a verified email on a listed domain) requires allowed_email_domains, e.g. ["acme.com"]; send it again with the full list to change it. Requires manage access (can_manage_report: owner or admin) — an editor cannot flip a private report public. Scope: sharing.

put/reports/{id}/share

Request

  • Base URL: https://commareports.com/api/v1
  • URL: https://commareports.com/api/v1/reports/{id}/share
  • Auth: HTTP bearer

Request body

visibility'private' | 'team' | 'registered' | 'domain' | 'public'
allowed_email_domainsstring[]

Required with, and only accepted with, visibility 'domain'. Bare domains (e.g. 'acme.com'); lowercased and de-duplicated. Replaces the existing list.

public_permission'none' | 'view' | 'comment' | 'edit'
show_approved_onlyboolean
allowed_embed_originsstring[] nullable

Bare origins (scheme + host + optional port, no path) allowed to iframe the report via /embed/{id}. https is required except for http://localhost and http://127.0.0.1. [] or null turns embedding off.

Response

Updated share settings.

idstring uuid required
visibilitystring required
public_permissionstring required
allowed_email_domainsstring[]
show_approved_onlyboolean required
allowed_embed_originsstring[] required
embed_urlstring nullable required

/embed/{id}, or null when embedding is off.

embed_snippetstring nullable required

Markup to paste into the host page, or null when embedding is off. Renders only while the report is public, its link permission isn't none, and it has no share password.

updated_atstring date-time required
share_urlstring required

Changes

No recorded changes to this operation across all 1 revision of this API.