Skip to main content
POST
Create workflow

Supported products

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
type
enum<string>
default:CONTACT_FLOW
required
Available options:
CONTACT_FLOW,
PLATFORM_FLOW
objectTypeId
string
required
canEnrollFromSalesforce
boolean
required
isEnabled
boolean
required
flowType
enum<string>
required
Available options:
WORKFLOW,
ACTION_SET,
UNKNOWN
actions
(STATIC_BRANCH · object | LIST_BRANCH · object | AB_TEST_BRANCH · object | CUSTOM_CODE · object | WEBHOOK · object | SINGLE_CONNECTION · object)[]
required
timeWindows
object[]
required
blockedDates
object[]
required
customProperties
object
required
dataSources
(ASSOCIATION · object | ASSOCIATION_TIMESTAMP · object | STATIC_PROPERTY_FILTER · object | ENROLLED_RECORD_PROPERTY_FILTER · object | DATASET_FIELD_PROPERTY_FILTER · object | ENROLLED_ARGUMENT_PROPERTY_FILTER · object)[]
required
suppressionListIds
integer<int32>[]
required
name
string
description
string
uuid
string
startActionId
string
enrollmentCriteria
LIST_BASED · object
enrollmentSchedule
DAILY · object
goalFilterBranch
OR · object
eventAnchor
CONTACT_PROPERTY_ANCHOR · object
unEnrollmentSetting
object

Response

successful operation

type
enum<string>
default:CONTACT_FLOW
required
Available options:
CONTACT_FLOW,
PLATFORM_FLOW
id
string
required
isEnabled
boolean
required
flowType
enum<string>
required
Available options:
WORKFLOW,
ACTION_SET,
UNKNOWN
revisionId
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
nextAvailableActionId
string
required
actions
(STATIC_BRANCH · object | LIST_BRANCH · object | AB_TEST_BRANCH · object | CUSTOM_CODE · object | WEBHOOK · object | SINGLE_CONNECTION · object)[]
required
timeWindows
object[]
required
blockedDates
object[]
required
customProperties
object
required
dataSources
(ASSOCIATION · object | ASSOCIATION_TIMESTAMP · object | STATIC_PROPERTY_FILTER · object | ENROLLED_RECORD_PROPERTY_FILTER · object | DATASET_FIELD_PROPERTY_FILTER · object | ENROLLED_ARGUMENT_PROPERTY_FILTER · object)[]
required
crmObjectCreationStatus
enum<string>
required
Available options:
PENDING,
COMPLETE
suppressionListIds
integer<int32>[]
required
canEnrollFromSalesforce
boolean
required
objectTypeId
string
required
name
string
description
string
uuid
string
startActionId
string
enrollmentCriteria
LIST_BASED · object
enrollmentSchedule
DAILY · object
goalFilterBranch
OR · object
eventAnchor
CONTACT_PROPERTY_ANCHOR · object
unEnrollmentSetting
object
Last modified on March 31, 2026