Docs

Run Universal Action

Run one published Universal API action through a connection. Pick the account with connectionId, installationId, or endUserId; with none of them, the company's default connection is used, or its only valid one. Needs the Universal permission for the action's operation: universal:read, universal:create, universal:update, or universal:delete (all four when the action declares none). Each app's Universal API pages list the arguments every action takes. File inputs default to 100,000,000 decoded bytes each; a positive argument fileMaxSize overrides that limit in MiB. The aggregate file budget is the larger of the default and the largest explicit argument limit. File actions have a ten-minute execution deadline. If a timeout or cancellation says remote completion is unknown, check the provider before retrying. When the provider answers with a failure, the run answers 502 PROVIDER_ERROR with the provider's code in error.details.reason and its HTTP status in error.details.provider.status; MindCloud's own refusals keep their own status and code.

POST

Path

Path parameters
stringrequired

The app slug from List Universal Apps.

stringrequired

The action slug from List Universal Actions.

Headers

Optional headers
string

Optional. The id of a child organization of your API key's company to act on. Leave it out to act on the key's own company. See Child organizations.

Body

Arguments
object

The action arguments, keyed by argument key. Get Universal Action lists them.

{ argumentKey: value } for the action, keyed as Get Universal Action lists them (requiredArguments and optionalArguments). Resolve a lookup argument with Resolve Universal Lookup.

string

The published app version. Defaults to latest.

Default: latest

string

The connection to run with, from List Connections, or from List Embedded End User Connections when you pass endUserId. Cannot be combined with installationId. Parent delegation cannot use Embedded connections, including by connectionId alone.

string

Run with the end user's connection on this embedded installation. Cannot be combined with connectionId.

string

Run with an account owned by this embedded end user. The API key company must own the end user.

object

Action options, when the action defines any.

{ optionKey: value } for the options the action defines, as Get Universal Action lists them. Most actions take none.

string

Comma-separated response fields to keep.

number

Maximum rows to return, for actions that support paging.

number

Rows to skip, for actions that support paging.

string

Sort fields, for actions that support sorting. Prefix with - for descending.

string

An RSQL filter, for actions that support filtering.