latestOpenAPI 3.0.12026-08-21183382785.0 KB

24caa8eb809b

Activations

Retrieve activation by ID

Retrieve an activation (formerly syndication) based on its identifier.

get/audiences/{audienceId}/segments/{segmentId}/syndications/{syndicationId}

Path parameters

audienceIdinteger required

Master Segment ID of the syndication

segmentIdinteger required

Segment ID of the syndication

syndicationIdinteger required

ID of Syndication to return

Response

successful operation

idstring integer

audienceIdstring integer

segmentIdstring integer

namestring

descriptionstring

allColumnsboolean

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

scheduleOptionstring nullable

startAtstring ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}$ nullable

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

endOnstring date nullable

repeatUnitstring nullable

repeatFrequencyinteger nullable

repeatSubFrequencyinteger[]

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

timezonestring

connectionIdstring integer nullable

connectorConfigobject nullable

createdAtstring date-time

updatedAtstring date-time

validboolean

notifyOnstring[]

emailRecipientsinteger[]

activationTemplateIdstring nullable

Example response

{
  "columns": [
    {
      "column": "alias_name",
      "source": {
        "column": "real_column_name"
      }
    }
  ],
  "scheduleType": "daily",
  "repeatSubFrequency": [
    1,
    5,
    6
  ]
}