Skip to main content
POST
Run an action on a shared 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

pid
string
required

Public ID of the shared report.

report_id
string
required

Report class ID. Defaults to the shared report's own class.

action_key
string
required

Key of the action to run, as listed in the report's actions block.

Query Parameters

token
string

Share token. Required when the report is marked secure, so its saved params apply.

Body

application/json
row_keys
string[]
required

Row identifiers to act on, taken from the field named by the report's row_key. Must be non-empty.

params
object

Optional action parameters.

Response

Action executed. Only message is guaranteed; other keys depend on the action.

status
string
message
string
data
object