Skip to content

Update an Activation Template

Request

Path
idinteger, (int64)required

Activation Template to update

Bodyapplication/vnd.treasuredata.v1+json
idstring[1-9][0-9]*
typestring
Value:"activation-template"
attributesobject(ActivationTemplateJsonApiParameters)
relationshipsobject
curl -i -X PATCH \
  'https://api-cdp.treasuredata.com/entities/activation_templates/{id}' \
  -H 'Content-Type: application/vnd.treasuredata.v1+json' \
  -d '{
    "id": "string",
    "type": "activation-template",
    "attributes": {
      "name": "string",
      "description": "string",
      "kind": 0,
      "allColumns": true,
      "columns": [
        {
          "column": "alias_name",
          "source": {
            "column": "real_column_name"
          }
        }
      ],
      "scheduleType": "daily",
      "scheduleOption": "string",
      "timezone": "string",
      "startAt": "string",
      "endOn": "2019-08-24",
      "repeatUnit": "none",
      "repeatFrequency": 1,
      "repeatSubFrequency": [
        1,
        5,
        6
      ],
      "connectionId": 0,
      "connectorConfig": {},
      "notifyOn": [
        "onSuccess"
      ],
      "emailRecipients": [
        0
      ],
      "state": "draft",
      "nestedWorkflowProjectName": "string",
      "nestedWorkflowName": "string",
      "lockEnabled": true,
      "runAfterJourneyRefresh": true,
      "syndicationBehavior": {
        "columns": [
          {
            "column": "alias_name",
            "source": {
              "column": "real_column_name"
            }
          }
        ],
        "behaviorTableName": "purchase_history",
        "joinRow": 3,
        "joinStrategy": "Last",
        "formatting": "rows",
        "orderBy": [
          {
            "key": "purchased_at",
            "order": "descending"
          },
          {
            "key": "price",
            "order": "ascending"
          }
        ]
      },
      "fieldProperties": {
        "locked": {
          "allColumns": true,
          "columns": {
            "b24bf298-4f8c-4e8a-8187-38f2efc781d9": {
              "column": true,
              "source": true,
              "lockDeleteColumn": false
            },
            "c97c5711-31dd-4563-aca9-795c0b429593": {
              "column": true,
              "source": true,
              "lockDeleteColumn": false
            }
          },
          "connectionId": true,
          "connectorConfig": {
            "userDatabaseName": true,
            "userTableName": true,
            "legacy": false,
            "mode": false
          },
          "activationActionsEnabled": true,
          "syndicationBehavior": {
            "tableName": "purchase_history",
            "columns": {
              "0ae6e876-9d9d-4217-8be2-f8646000d0c2": {
                "column": true,
                "source": true,
                "lockDeleteColumn": false
              },
              "b71d422e-4f29-47d5-b072-7e598275a402": {
                "column": true,
                "source": true,
                "lockDeleteColumn": false
              }
            },
            "lockAddColumn": true,
            "lockDeleteBehaviorTable": true,
            "lockEditBehaviorTable": true,
            "lockEditJoinRow": true,
            "lockEditJoinStrategy": true,
            "lockEditFormatting": true,
            "lockEditOrderBy": true
          },
          "lockAddColumn": true,
          "lockAddString": true,
          "lockAddBehavior": true,
          "lockEditSchedule": true,
          "lockEditNotification": true,
          "lockEditWorkflowExecution": true,
          "lockEditSequentialActivation": true
        }
      }
    },
    "relationships": {
      "parentFolder": {
        "data": {
          "id": "string",
          "type": "folder-segment"
        }
      }
    }
  }'

Responses

Updated Activation Template

Bodyapplication/json
dataobject(ActivationTemplateJsonApiResource)required
includedArray of objects(UserJsonApiResource)required
Response
{ "data": { "id": "string", "type": "activation-template", "attributes": {}, "relationships": {} }, "included": [ {} ] }