Update trigger

PATCH

/api/v1/triggers/{id}

Update variables, data_mappings (replaces all), description, or activation. activate:true activates (registers webhooks); false pauses.

Request

Authorization

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

Body Params application/json

Example

{
    "variables": {
        "property1": "string",
        "property2": "string"
    },
    "data_mappings": [
        {
            "mapping_for": "recipient",
            "value": {
                "property1": "string",
                "property2": "string"
            }
        }
    ],
    "description": "string",
    "activate": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH '/api/v1/triggers/trig_1234abcd' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "variables": {
        "property1": "string",
        "property2": "string"
    },
    "data_mappings": [
        {
            "mapping_for": "recipient",
            "value": {
                "property1": "string",
                "property2": "string"
            }
        }
    ],
    "description": "string",
    "activate": true
}'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "id": "string",
    "stream_id": "string",
    "status": "draft",
    "description": "string",
    "condition": {
        "expression_id": "string",
        "topic": "string",
        "variables": {}
    },
    "data_mappings": [
        {
            "mapping_for": "recipient",
            "value": {
                "property1": "string",
                "property2": "string"
            }
        }
    ]
}

🟠404Not found

Modified at 2026-06-03 12:30:45

Create trigger

List condition library