Update activation

Update an activation (formerly syndication).

SecurityTdApikeyAuth
Request
path Parameters
audienceId
required
integer <int64>

Master Segment ID of the syndication

segmentId
required
integer <int64>

Segment ID of the syndication

syndicationId
required
integer <int64>

ID of Syndication to return

Request Body schema: application/json
name
required
string
description
string
allColumns
boolean

syndication all column flag ('true' means that you use all attribute data)

Array of objects (Columns)

Syndication column detail. Basic syntax is {"column": "alias_name", "source": {...}}. source accepts various definitions. See ColumnExpression/StringExpression for details. example value is using ColumnExpression without function property.

scheduleType
string (DeprecatedScheduleType)
Deprecated

Deprecated. Old parameter for setting schedule type. See/Use RepeatUnit instead.

Enum: "cron" "daily" "hourly" "minutes_interval" "monthly" "none" "weekly"
scheduleOption
string
Deprecated

Deprecated. Old parameter for setting schedule. Use startAt instead.

repeatUnit
string (RepeatUnit)

Setting an activation repetition cycle such as "day" or "week".

Enum: "none" "minute" "hour" "day" "week" "month" "once"
repeatFrequency
integer (RepeatFrequency)
Default: 1

Setting an activation repeat frequency. Currently, it is set only when the repeat unit is "minute". If the repeat unit is "minute", the interval is set in minutes.

repeatSubFrequency
Array of integers <int64> (RepeatSubFrequency)
Default: []

Parameter for more detailed frequency settings. Values are array of integers. Currently, this parameter is only valid for repeat unit "week". For multiple days of the week, each value should be 1 to 7. 1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday, 7: Sunday

startAt
string or null <^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$> (StartAt)

cdp-api will fill some value for old syndications with ScheduleType is not NoneType. '%Y-%M-%DT%h:%m:%s' is expected.

runAt
string
cron
string
timezone
string
connectionId
integer or null <int64>
connectorConfig
object or null
notifyOn
Array of strings
Items Enum: "onSuccess" "onFailure"
emailRecipients
Array of integers <int64>
nestedWorkflowProjectName
string
nestedWorkflowName
string
lockEnabled
boolean
activationTemplateId
string or null[1-9][0-9]*
object or null
Responses
200

successful operation

400

Given parameters are not valid

401

Unauthorized; You don't provide valid credentials. Maybe you didn't specify valid TD's Master API Key as 'TD1 {Your TD Master API Key}'.

403

Requested resource or action is not allowed because you don't have sufficient permissions

404

The specified resource was not found

4XX

There is a high possibility of error of the authentication system. Please check the contents and authority of the key. Please contact the TD support team if you do not resolve it.

5XX

System error. Because there is a possibility of a temporary error due to network trouble and so on, we recommend several times retry on request side. Please contact the TD support team if you do not resolve it.

put/audiences/{audienceId}/segments/{segmentId}/syndications/{syndicationId}
Request samples
application/json
{
  • "name": "string",
  • "description": "string",
  • "allColumns": true,
  • "columns": [
    ],
  • "scheduleType": "daily",
  • "scheduleOption": "string",
  • "repeatUnit": "none",
  • "repeatFrequency": 1,
  • "repeatSubFrequency": [
    ],
  • "startAt": "string",
  • "runAt": "string",
  • "cron": "string",
  • "timezone": "string",
  • "connectionId": 0,
  • "connectorConfig": { },
  • "notifyOn": [
    ],
  • "emailRecipients": [
    ],
  • "nestedWorkflowProjectName": "string",
  • "nestedWorkflowName": "string",
  • "lockEnabled": true,
  • "activationTemplateId": "string",
  • "syndicationBehavior": {
    }
}
Response samples
application/json
{
  • "id": "string",
  • "audienceId": "string",
  • "segmentId": "string",
  • "name": "string",
  • "description": "string",
  • "allColumns": true,
  • "columns": [
    ],
  • "scheduleType": "daily",
  • "scheduleOption": "string",
  • "repeatSubFrequency": [
    ],
  • "timezone": "string",
  • "connectionId": "string",
  • "connectorConfig": { },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    },
  • "updatedBy": {
    },
  • "valid": true,
  • "executions": [
    ],
  • "notifyOn": [
    ],
  • "emailRecipients": [
    ],
  • "activationTemplateId": "string"
}