Pipedream · Schema

ConfigurePropOpts

Request options for configuring a component's prop

ProCode_API_CompositionWorkflowsConnectMCPEmbedded IntegrationsManaged AuthAI Agents

Properties

Name Type Description
id string The component ID
version string Optional component version (in SemVer format, for example '1.0.0'), defaults to latest
external_user_id string The external user ID
prop_name string The name of the prop to configure
blocking boolean Whether this operation should block until completion
configured_props object
dynamic_props_id string The ID for dynamic props
page number Page number for paginated results
prev_context object Previous context for pagination
query string Search query for filtering options
View JSON Schema on GitHub

JSON Schema

pipedream-configurepropopts-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ConfigurePropOpts",
  "title": "ConfigurePropOpts",
  "type": "object",
  "description": "Request options for configuring a component's prop",
  "required": [
    "id",
    "external_user_id",
    "prop_name"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The component ID"
    },
    "version": {
      "type": "string",
      "description": "Optional component version (in SemVer format, for example '1.0.0'), defaults to latest",
      "example": "1.2.3",
      "nullable": true
    },
    "external_user_id": {
      "type": "string",
      "description": "The external user ID"
    },
    "prop_name": {
      "type": "string",
      "description": "The name of the prop to configure"
    },
    "blocking": {
      "type": "boolean",
      "description": "Whether this operation should block until completion"
    },
    "configured_props": {
      "$ref": "#/components/schemas/ConfiguredProps"
    },
    "dynamic_props_id": {
      "type": "string",
      "description": "The ID for dynamic props"
    },
    "page": {
      "type": "number",
      "description": "Page number for paginated results"
    },
    "prev_context": {
      "type": "object",
      "description": "Previous context for pagination"
    },
    "query": {
      "type": "string",
      "description": "Search query for filtering options"
    }
  }
}