Patch action

Path Params
string
required
Query Params
string
enum
Allowed:
string
string
string
string
Body Params
string

Stable unique identifier (UUID). Can be provided on create; otherwise generated. Must be unique across elements of this type.

string

Stable key for referencing the element (e.g. in selectors). Unique per (parent, integration) scope. Generated from name if not provided on create.

string

Display name. Optional on create; used to generate key when key is omitted.

string

Optional human-readable description.

meta
object

Optional key-value metadata.

string

Internal ID of the integration this element belongs to. Omit for universal elements; set for integration-specific elements. Uniqueness of key is scoped per integration.

string

UUID of the integration; alternative to integrationId when creating from export. Resolved to integrationId by the API.

string

Key of the integration; alternative to integrationId. Resolved to integrationId by the API.

string

Internal ID of the parent workspace element. Used for hierarchy (e.g. integration-level under universal). Child key uniqueness is scoped by parent and integration.

string

UUID of the parent element; alternative to parentId when creating (e.g. from export). Resolved to parentId by the API.

string

Key of the parent element; alternative to parentId. Resolved to parentId by the API.

string

Connection ID for filtering or for connection-level instances. Same semantics as base integration-level property.

string

Key for the connection-level instance when multiple exist per connection. Same semantics as base integration-level property.

boolean

When true, the element is universal (shared across all integrations). Requires universal-element access. Omit or false for integration-specific elements.

string

Internal ID of the external app this element belongs to. Auto-populated from the integration when integrationId is set and the integration has an externalAppId.

string

UUID of the external app; alternative to externalAppId when creating from export. Resolved to externalAppId by the API.

string

Key of the external app; alternative to externalAppId. Resolved to externalAppId by the API.

inputSchema
object

JSON Schema for the action input. Used by the action engine for template output schema, run-time variables, and output mapping.

string
enum

Action type (e.g. ConnectorOperation, RunJavascript). Determines which handler runs and which config schema is used for validation.

string

Mapping expression to transform the action's raw output. Evaluated with access to input, output, and user; used to compute transformed output schema and at run time.

customOutputSchema
object

Explicit output schema for the action. Takes precedence over the transformed or default output schema when resolving outputSchema.

string

[Experimental] Intent-based instruction for an agent to configure this element.

Response

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json