Skip to main content
POST
/
v1
/
connect
/
{project_id}
/
actions
/
configure
cURL
curl --request POST \
  --url https://api.pipedream.com/v1/connect/{project_id}/actions/configure \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-pd-environment: <x-pd-environment>' \
  --data '
{
  "id": "<string>",
  "external_user_id": "<string>",
  "prop_name": "<string>",
  "version": "1.0.0",
  "blocking": true,
  "configured_props": {},
  "dynamic_props_id": "<string>",
  "page": 123,
  "prev_context": {},
  "query": "<string>"
}
'
import { PipedreamClient } from "@pipedream/sdk";

const client = new PipedreamClient({
clientId: "YOUR_CLIENT_ID",
clientSecret: "YOUR_CLIENT_SECRET",
projectEnvironment: "YOUR_PROJECT_ENVIRONMENT",
projectId: "YOUR_PROJECT_ID"
});
await client.actions.configureProp({
id: "id",
externalUserId: "external_user_id",
propName: "prop_name"
});
from pipedream import Pipedream

client = Pipedream(
project_id="YOUR_PROJECT_ID",
client_id="YOUR_CLIENT_ID",
client_secret="YOUR_CLIENT_SECRET",
)
client.actions.configure_prop(
id="id",
external_user_id="external_user_id",
prop_name="prop_name",
)
package com.example.usage;

import com.pipedream.api.BaseClient;
import com.pipedream.api.types.ConfigurePropOpts;

public class Example {
public static void main(String[] args) {
BaseClient client = BaseClient.withCredentials("<clientId>", "<clientSecret>")
.projectId("YOUR_PROJECT_ID")
.build()
;

client.actions().configureProp(
ConfigurePropOpts
.builder()
.id("id")
.externalUserId("external_user_id")
.propName("prop_name")
.build()
);
}
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.pipedream.com/v1/connect/{project_id}/actions/configure"

payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"external_user_id\": \"<string>\",\n \"prop_name\": \"<string>\",\n \"version\": \"1.0.0\",\n \"blocking\": true,\n \"configured_props\": {},\n \"dynamic_props_id\": \"<string>\",\n \"page\": 123,\n \"prev_context\": {},\n \"query\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-pd-environment", "<x-pd-environment>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
{
  "options": [
    {
      "label": "<string>",
      "value": "<string>"
    }
  ],
  "stringOptions": [
    "<string>"
  ],
  "observations": [
    {
      "k": "<string>",
      "ts": 123,
      "err": {
        "name": "<string>",
        "message": "<string>",
        "stack": "<string>"
      },
      "msg": "<string>"
    }
  ],
  "context": {},
  "errors": [
    "<string>"
  ]
}
{
"error": "Throttled"
}

Authorizations

Authorization
string
header
required

A short-lived Connect token for client-side requests on behalf of an end user. Generate one via the Create Connect token endpoint.

Headers

x-pd-environment
enum<string>
required

The environment in which the server client is running

Available options:
development,
production

Path Parameters

project_id
string
required

The project ID, which starts with proj_.

Pattern: ^proj_[a-zA-Z0-9]+$

Body

application/json

Request options for configuring a component's prop

id
string
required

The component ID

external_user_id
string
required

The external user ID

prop_name
string
required

The name of the prop to configure

version
string | null
default:latest

Component semantic version

Example:

"1.0.0"

blocking
boolean

Whether this operation should block until completion

configured_props
object

The configured properties of the component

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

Response

action configuration started

Response received after configuring a component's prop

options
object[] | null

Available options (with labels) for the configured prop

A configuration option for a component's prop

stringOptions
string[] | null

Available options for the configured prop

observations
object[] | null
context
object | null

New context after configuring the prop

errors
string[]

Any errors that occurred during configuration