Sign in

v1

latestOpenAPI 3.1.02026-07-2419603.1 MB
Data Activation

Update activation

Update a single activation. Requires edit permission.

put/api/cdp/settings/v1/app/{app_id}/activation/{id}

Request body

OR
OR

Example request

{
  "name": "My activation",
  "description": "Description of my activation",
  "status": "active",
  "trigger": "onjoin",
  "audience_id": "0d454742-0e95-4321-a200-fd9d1c4b8031",
  "required_consents": [
    "ab_testing_and_personalization",
    "remarketing"
  ],
  "multiple": true,
  "webhook_url": "https://domain.tld/path.php?c=param",
  "webhook_body_attributes": [
    {
      "key": "lang",
      "value": "device_type",
      "column_meta": {
        "column_name": "Browser Type",
        "column_type": "string",
        "column_unit": "currency",
        "column_category": [
          "Device"
        ],
        "analytics_column_id": "goal_revenue",
        "analytics_transformation_id": "sum",
        "value_selectors": [
          "first"
        ],
        "extractions": [
          "first"
        ],
        "aggregation": "first",
        "scope": "event"
      },
      "extraction": "first",
      "custom_value": "my custom value"
    }
  ],
  "webhook_body_template": "{\n  \"const\": \"hello there\",\n  \"text\": \"Hi {user_id:first}! Thanks for making a {total_revenue} dollar purchase.\"\n}\n"
}

Response

Activation object after update

OR
OR

Example response

{
  "id": "ca2f7459-e6e6-466b-a4a9-d9af89682c3b",
  "name": "My activation",
  "description": "Description of my activation",
  "status": "active",
  "trigger": "onjoin",
  "audience": {
    "id": "aaa1550f-b5a5-4626-a4ac-2f99ff8148fe",
    "name": "My audience"
  },
  "required_consents": [
    "ab_testing_and_personalization",
    "remarketing"
  ],
  "multiple": true,
  "created_at": "2020-07-14T13:30:07Z",
  "updated_at": "2020-07-14T13:30:07Z",
  "author": {
    "email": "author@piwik.pro"
  },
  "webhook_url": "https://domain.tld/path.php?c=param",
  "webhook_body_attributes": [
    {
      "key": "lang",
      "value": "device_type",
      "column_meta": {
        "column_name": "Browser Type",
        "column_type": "string",
        "column_unit": "currency",
        "column_category": [
          "Device"
        ],
        "analytics_column_id": "goal_revenue",
        "analytics_transformation_id": "sum",
        "value_selectors": [
          "first"
        ],
        "extractions": [
          "first"
        ],
        "aggregation": "first",
        "scope": "event"
      },
      "extraction": "first",
      "custom_value": "my custom value"
    }
  ],
  "webhook_body_template": "{\n  \"const\": \"hello there\",\n  \"text\": \"Hi {user_id:first}! Thanks for making a {total_revenue} dollar purchase.\"\n}\n"
}