Create activation

Create an activation (formerly syndication).

Request

path Parameters

segmentId

required

integer <int64>

Segment to create Activation

Request Body schema: application/vnd.treasuredata.v1+json

id	string[1-9][0-9]*
type	string Value: "syndication"
	object (SyndicationJsonApiParameters)

Responses

200

Created Activation

post/entities/segments/{segmentId}/syndications

Request samples

Payload
curl
JS

application/vnd.treasuredata.v1+json

{"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,
"formatting": "rows",
"orderBy": [{"key": "purchased_at",
"order": "descending"
},
{"key": "price",
"order": "ascending"
}
]
}
}
}

Response samples

application/vnd.treasuredata.v1+json

{"data": {"id": "string",
"type": "syndication",
"attributes": {"audienceId": "string",
"name": "string",
"description": "string",
"allColumns": true,
"columns": [{"column": "alias_name",
"source": {"column": "real_column_name"
}
}
],
"scheduleType": "daily",
"scheduleOption": "string",
"timezone": "string",
"startAt": "string",
"endOn": "2019-08-24",
"runStatus": "scheduled",
"repeatUnit": "none",
"repeatFrequency": 1,
"repeatSubFrequency": [1,
5,
6
],
"connectionId": "string",
"connectorConfig": { },
"valid": true,
"notifyOn": ["onSuccess"
],
"emailRecipients": [0
],
"executions": [{"workflowId": "string",
"workflowSessionId": "string",
"createdAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"status": "success",
"workflowAttemptId": "string",
"syndicationId": "string"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"nestedWorkflowProjectName": "string",
"nestedWorkflowName": "string",
"activationActionsEnabled": true,
"lockEnabled": true,
"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"
}
]
}
},
"relationships": {"segment": {"data": {"id": "string",
"type": "segment-batch"
}
},
"createdBy": {"data": {"id": "string",
"type": "user"
}
},
"updatedBy": {"data": {"id": "string",
"type": "user"
}
}
}
},
"included": [{"id": "string",
"type": "user",
"attributes": {"tdUserId": "string",
"name": "string"
}
}
]
}