Skip to main content
POST
Share a custom report

Authorizations

x-conveyour-token
string
header
required

Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.

Path Parameters

id
string
required

The id identifier.

Query Parameters

teams[]
string[]

Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.

Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.

Body

application/json
params
object

The parameter values to encode in the JWT token. Used for locked parameters that differ per share link (e.g. scoping a report to a specific office ID).

expires
string

Token expiration window. Default: +8 hours. Options: +1 hour, +8 hours, +24 hours, +7 days, +30 days, +90 days, +1 year.

config
object

Extra configuration to encode into the share token. Supplying this forces a custom token to be generated, and only takes effect on a secure report.

Response

Success.

The common response envelope shared by all ConveYour endpoints.

status
enum<string>

ok on success, failed on error.

Available options:
ok,
failed
message
string

Human-readable description of the result.

data
object

The response payload — an object or an array depending on the endpoint.