Skip to main content
PATCH
/
api
/
v1
/
beam
/
{config_id}
/
transforms
/
{transform_uid}
Update Transform Handler
curl --request PATCH \
  --url https://api.allium.so/api/v1/beam/{config_id}/transforms/{transform_uid} \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "script": "<string>",
  "uid": "<string>",
  "type": "v8"
}
'
{
  "script": "<string>",
  "uid": "<string>",
  "type": "v8"
}
Updates one transform by its UID. The pipeline is automatically redeployed after the update.
Required permission: edit — owners and editors.
Path parameters:
ParameterDescription
config_idPipeline configuration ID
transform_uidUID of the transform to update
Request body: BeamTransformerConfig 
curl -X PATCH https://api.allium.so/api/v1/beam/${CONFIG_ID}/transforms/${TRANSFORM_UID} \
  -H "X-API-Key: ${ALLIUM_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "v8",
    "script": "function transform(record) { record.parsed = true; return record; }"
  }'
Response: The updated BeamTransformerConfig object.

Authorizations

​
X-API-KEY
string
header
required

Path Parameters

​
config_id
string
required
​
transform_uid
string
required

Body

application/json
​
script
string
required
​
uid
string
Maximum string length: 128
​
type
string
default:v8
Allowed value: "v8"

Response

Successful Response

​
script
string
required
​
uid
string
Maximum string length: 128
​
type
string
default:v8
Allowed value: "v8"