Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

Your Recoup API key. Learn more.

Body

application/json

Action to execute and the parameters for it

actionSlug
string
required

Action slug from GET /api/connectors/actions. Always UPPERCASE_SNAKE_CASE (e.g. GOOGLESHEETS_WRITE_SPREADSHEET). Required.

parameters
object
required

Action-specific parameters matching the parameters JSON Schema returned by GET /api/connectors/actions for this actionSlug. The connector validates these against the cached schema before executing — invalid shapes return 400. Required.

account_id
string<uuid>

Optional account ID to execute the action on a different account (e.g., an artist). The authenticated account must have access. Omit to execute on your own account.

Response

Action executed successfully

success
boolean
required
result
object
required

Pass-through of the underlying connector's response payload. Shape is action-specific — consult the action's parameters schema and the third-party service's own documentation for what to expect. The server-side wrapper does not transform this field.

executedAt
string<date-time>

ISO 8601 timestamp of when the action was executed server-side.