TRtreasure
Activation Templates

Create an Activation Template

Changed on
post/entities/activation_templates

Request

Request body

idstring
type'activation-template'

Example request

{
  "attributes": {
    "columns": [
      {
        "column": "alias_name",
        "source": {
          "column": "real_column_name"
        }
      }
    ],
    "scheduleType": "daily",
    "repeatSubFrequency": [
      1,
      5,
      6
    ],
    "syndicationBehavior": {
      "columns": [
        {
          "column": "alias_name",
          "source": {
            "column": "real_column_name"
          }
        }
      ],
      "behaviorTableName": "purchase_history",
      "joinRow": 3,
      "joinStrategy": "Last",
      "orderBy": [
        {
          "key": "purchased_at",
          "order": "descending"
        },
        {
          "key": "price",
          "order": "ascending"
        }
      ]
    },
    "fieldProperties": {
      "locked": {
        "columns": {
          "b24bf298-4f8c-4e8a-8187-38f2efc781d9": {
            "column": true,
            "source": true,
            "lockDeleteColumn": false
          },
          "c97c5711-31dd-4563-aca9-795c0b429593": {
            "column": true,
            "source": true,
            "lockDeleteColumn": false
          }
        },
        "connectorConfig": {
          "userDatabaseName": true,
          "userTableName": true,
          "legacy": false,
          "mode": false
        },
        "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
            }
          }
        }
      }
    }
  }
}

Response

Created Activation Template

Example response

{
  "data": {
    "attributes": {
      "columns": [
        {
          "column": "alias_name",
          "source": {
            "column": "real_column_name"
          }
        }
      ],
      "scheduleType": "daily",
      "repeatSubFrequency": [
        1,
        5,
        6
      ],
      "syndicationBehavior": {
        "columns": [
          {
            "column": "alias_name",
            "source": {
              "column": "real_column_name"
            }
          }
        ],
        "behaviorTableName": "purchase_history",
        "joinRow": 3,
        "joinStrategy": "Last",
        "orderBy": [
          {
            "key": "purchased_at",
            "order": "descending"
          },
          {
            "key": "price",
            "order": "ascending"
          }
        ]
      },
      "fieldProperties": {
        "locked": {
          "columns": {
            "b24bf298-4f8c-4e8a-8187-38f2efc781d9": {
              "column": true,
              "source": true,
              "lockDeleteColumn": false
            },
            "c97c5711-31dd-4563-aca9-795c0b429593": {
              "column": true,
              "source": true,
              "lockDeleteColumn": false
            }
          },
          "connectorConfig": {
            "userDatabaseName": true,
            "userTableName": true,
            "legacy": false,
            "mode": false
          },
          "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
              }
            }
          }
        }
      }
    }
  }
}

Changes

  • 24caa8eb809bRevision changes
    • info

      api operation id activation_templates#create removed and replaced with activation_templates_create