Create an activation step in journey

Create an activation step in a journey.

SecurityTdApikeyAuth

Request

path Parameters

journeyId

required

integer <int64>

Journey ID

Request Body schema: application/json

parameters to configure the journey activation step

id required	string[1-9][0-9]*
type required	string Value: "journeyActivationStep"
required	object
required	object

Responses

200

Returns a summary of the activation step in the journey

post/entities/journeys/{journeyId}/activations

Request samples

Payload
curl
JS

application/json

{"id": "string",
"type": "journeyActivationStep",
"attributes": {"activationId": "string",
"activationParams": {"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,
"connectionId": "string",
"connectorConfig": { },
"notifyOn": ["onSuccess"
],
"emailRecipients": [0
],
"activationTemplateId": "string",
"nestedWorkflowProjectName": "string",
"nestedWorkflowName": "string",
"lockEnabled": true,
"activationActionsEnabled": true,
"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": {"createdBy": {"data": {"id": "string",
"type": "user"
}
},
"updatedBy": {"data": {"id": "string",
"type": "user"
}
}
}
}

Response samples

application/json

{"data": {"id": "string",
"type": "journeyActivationStep",
"attributes": {"activationId": "string",
"activationParams": {"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,
"connectionId": "string",
"connectorConfig": { },
"notifyOn": ["onSuccess"
],
"emailRecipients": [0
],
"activationTemplateId": "string",
"nestedWorkflowProjectName": "string",
"nestedWorkflowName": "string",
"lockEnabled": true,
"activationActionsEnabled": true,
"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": {"createdBy": {"data": {"id": "string",
"type": "user"
}
},
"updatedBy": {"data": {"id": "string",
"type": "user"
}
}
}
},
"included": [{"id": "string",
"type": "user",
"attributes": {"tdUserId": "string",
"name": "string"
}
}
]
}