Skip to main content
POST
Create 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.

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
class
string
required

The camelCase ID of the report class to render (e.g. campaignsCampaignPerformance).

title
string

Display name for this saved report configuration.

secure
boolean

When true (default), parameters are JWT-encoded in the share URL. When false, params go as plain query strings.

portal_visible
boolean

When true, this report is visible to contacts via the portal. Default: false.

teams
string[]

Team IDs that restrict access to this report. Empty array = all teams.

input
object

Map of control parameter keys to their rule and default value. Each entry: { "rule": "locked" | "editable", "value": "..." }.

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

A saved custom report.