Skip to content
API Documents/
/
/
Create activation

Create activation

Request

Create an activation (formerly syndication).

Path
segmentIdinteger, (int64)required

Segment to create Activation

Bodyapplication/vnd.treasuredata.v1+json
idstring[1-9][0-9]*
typestring
Value:"syndication"
attributesobject(SyndicationJsonApiParameters)
curl -i -X POST \
  'https://api-cdp.treasuredata.com/entities/segments/{segmentId}/syndications' \
  -H 'Content-Type: application/vnd.treasuredata.v1+json' \
  -d '{
    "id": "string",
    "type": "syndication",
    "attributes": {
      "name": "string",
      "description": "string",
      "allColumns": true,
      "columns": [
        {
          "column": "alias_name",
          "source": {
            "column": "real_column_name"
          }
        }
      ],
      "scheduleType": "daily",
      "scheduleOption": "string",
      "runAt": "string",
      "cron": "string",
      "timezone": "string",
      "startAt": "string",
      "endOn": "2019-08-24",
      "repeatUnit": "none",
      "repeatFrequency": 1,
      "repeatSubFrequency": [
        1,
        5,
        6
      ],
      "connectionId": 0,
      "connectorConfig": {},
      "notifyOn": [
        "onSuccess"
      ],
      "emailRecipients": [
        0
      ],
      "activationTemplateId": "string",
      "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"
          }
        ]
      },
      "syndicationBehaviors": [
        {
          "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"
            }
          ]
        }
      ]
    }
  }'

Responses

Created Activation

Bodyapplication/vnd.treasuredata.v1+json
dataobject(SyndicationJsonApiResource)required
includedArray of objects(UserJsonApiResource)required
Response
{
  "data": {
    "id": "string",
    "type": "syndication",
    "attributes": { … },
    "relationships": { … }
  },
  "included": [
    { … }
  ]
}