Skip to main content
POST
/
v1
/
connect
/
{project_id}
/
components
/
configure
cURL
curl --request POST \
  --url https://api.pipedream.com/v1/connect/{project_id}/components/configure \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-pd-environment: <x-pd-environment>' \
  --data '{
  "id": "<string>",
  "version": "1.2.3",
  "external_user_id": "<string>",
  "prop_name": "<string>",
  "blocking": true,
  "configured_props": {},
  "dynamic_props_id": "<string>",
  "page": 123,
  "prev_context": {},
  "query": "<string>"
}'
{
  "options": [
    {
      "label": "<string>",
      "value": "<string>"
    }
  ],
  "string_options": [
    "<string>"
  ],
  "observations": [
    {
      "err": {
        "name": "<string>",
        "message": "<string>",
        "stack": "<string>"
      },
      "k": "<string>",
      "msg": "<string>",
      "ts": 123
    }
  ],
  "context": {},
  "errors": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

Headers

x-pd-environment
enum<string>
required
Available options:
development,
production

Path Parameters

project_id
string
required

Body

application/json
id
string
required
external_user_id
string
required
prop_name
string
required
version
string | null
Example:
blocking
boolean
configured_props
object
dynamic_props_id
string
page
number
prev_context
object
query
string

Response

options
object[] | null
  • Option 1
  • Option 2
string_options
string[] | null
observations
object[] | null
context
object | null
errors
string[]