Skip to main content
POST
Share run

Path Parameters

shortId
string
required

Body

application/json

Request body for a run's public share link. Only projectShortId is needed for the plain link, and only for org-scoped keys.

projectShortId
string

Target a specific project by its prefixed short ID (proj-slug_shortId or proj_shortId), as returned by the projects API. Required for organization-scoped API keys; project-scoped keys may only pass their own project's short ID.

Pattern: ^proj(-.+_.+|_.+)$
audience
enum<string>

What the link shows. Omit it to create the plain run link, or to leave an existing link unchanged. sales switches the link to the sales report and is limited to QA.tech admins. general switches it back to the plain run, which is also limited to QA.tech admins when the link currently shows the sales report.

Available options:
general,
sales

Response

200 - application/json

The request has succeeded.

success
boolean
required
run
object
required
audience
enum<string>
required

What the link shows right now: general for the plain run, or sales for the sales report.

Available options:
general,
sales
shareUrl
string
required

Public URL for the run. Anyone with the link can open it without signing in. What they see depends on audience.