Skip to main content
POST
Run a report action

Authorizations

x-conveyour-token
string
header
required

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

Path Parameters

action_key
string
required

The action_key identifier.

report_id
string
required

The report_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
row_keys
string[]
required

The row identifier values for the selected rows (uses the report's row_key field).

params
object

Additional parameters collected from the action's confirmation dialog fields (e.g. file_name).

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 array returned by the report class's action method. Only message is guaranteed; it defaults to Action completed. Remaining keys are defined by the individual action.