Skip to main content
Save Email Flow

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Body

The EmailFlow that is saved

Email flow carrier Carrier object for EmailFlow. Services for the EmailFlow Carrier is available from the Workflow Agent.

EmailFlowId
integer<int32>

Primary key

Name
string

Name of the workflow

Description
string

Description of the workflow

Status
enum<string>

Status of the workflow definition

Available options:
None,
Stopped,
Paused,
Running
JumpToFinish
boolean

When a goal is reached, contact jumps directly to finished

StartOnlyOnce
boolean

A contact can start this flow only once

Override consent and subscription

FromType
enum<string>

Email/Mailing From field address algorithm

Available options:
FromOnlySpecified,
FromSalesContact,
FromSupportContact
FromName
string

Email From name

FromAddr
string

Email From address: name@domain.com

ReplyToType
enum<string>

Email/Mailing Reply-To field address algorithm

Available options:
ReplyToOnlySpecified,
ReplyToSalesContact,
ReplyToSupportContact,
ReplyToEmpty
ReplyToAddr
string

Reply to address, if different from From-address

ReplyToName
string

Email Reply-To name

SmsSender
string

SMS sender (number or name)

UseGoogleAnalytics
boolean

Use Google Analytics

GaSource
string

GA Source

GaCampaign
string

GA Campaign

UseTimeframe
boolean

Use sender timeframe settings, only send email/sms within the timeframe

SelectedDays
enum<string>

Selected days (flags, so several days can be selected) for time frame

Available options:
Unknown,
Monday,
Tuesday,
Wednesday,
Thursday,
Friday,
Saturday,
Sunday
TimeframeStart
string

Start of email/sms sending timeframe in [DT: ] format, interpreted in workflow time zone

TimeframeEnd
string

End of email/sms sending timeframe in [DT: ] format, interpreted in workflow time zone

UseWorkflowStart
boolean

Start the flow running with enrolled participants at the given time

WorkflowStart
string

When to start running the workflow. Until start, any enrolled members are not running through the flow, just waiting. In [DT: ] format, interpreted in workflow time zone

UseEnrollmentEnd
boolean

End enrollment into the workflow at the given time

EnrollmentEnd
string

Do not enroll more participant after given time. In [DT: ] format, interpreted in workflow time zone

RemoveFromFlows
integer<int32>[]

Workflows to remove the participants from when they are enrolled in this workflow

TzLocation
object
Folder
object

Folder structures Carrier object for HierarchyEntity. Services for the HierarchyEntity Carrier is available from the List Agent.

Associate
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

ShipmentType
object

Carrier object for MDOListItem. Services for the MDOListItem Carrier is available from the MDO Agent.

Steps
object[]

The steps in the workflow, mainline steps - forking steps are indicated by its WorkflowStepType.

Triggers
object[]

The triggers for the workflow.

Goals
object[]

The goals for the workflow.

Filter
object

Workflow filter carrier Carrier object for WorkflowFilter. Services for the WorkflowFilter Carrier is available from the Workflow Agent.

BlockLists
integer<int32>[]

Persons in the given selections are not allowed to enter this workflow

ContentInfo
object[]

Info about workflow content like messages, links and forms (read-only)

ExitFlowId
integer<int32>

On exit with no success criteria met, we attempt to add the participant to the given flow

ExitSuccessFlowId
integer<int32>

On exit with success criteria met, we attempt to add the participant to the given flow

CreatedBy
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

UpdatedBy
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

CreatedDate
string<date-time>

Registered date in UTC.

UpdatedDate
string<date-time>

Updated date in UTC.

VisibleFor
object[]

The set of users or groups the record is visible for

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.

Response

OK

Email flow carrier Carrier object for EmailFlow. Services for the EmailFlow Carrier is available from the Workflow Agent.

EmailFlowId
integer<int32>

Primary key

Name
string

Name of the workflow

Description
string

Description of the workflow

Status
enum<string>

Status of the workflow definition

Available options:
None,
Stopped,
Paused,
Running
JumpToFinish
boolean

When a goal is reached, contact jumps directly to finished

StartOnlyOnce
boolean

A contact can start this flow only once

Override consent and subscription

FromType
enum<string>

Email/Mailing From field address algorithm

Available options:
FromOnlySpecified,
FromSalesContact,
FromSupportContact
FromName
string

Email From name

FromAddr
string

Email From address: name@domain.com

ReplyToType
enum<string>

Email/Mailing Reply-To field address algorithm

Available options:
ReplyToOnlySpecified,
ReplyToSalesContact,
ReplyToSupportContact,
ReplyToEmpty
ReplyToAddr
string

Reply to address, if different from From-address

ReplyToName
string

Email Reply-To name

SmsSender
string

SMS sender (number or name)

UseGoogleAnalytics
boolean

Use Google Analytics

GaSource
string

GA Source

GaCampaign
string

GA Campaign

UseTimeframe
boolean

Use sender timeframe settings, only send email/sms within the timeframe

SelectedDays
enum<string>

Selected days (flags, so several days can be selected) for time frame

Available options:
Unknown,
Monday,
Tuesday,
Wednesday,
Thursday,
Friday,
Saturday,
Sunday
TimeframeStart
string

Start of email/sms sending timeframe in [DT: ] format, interpreted in workflow time zone

TimeframeEnd
string

End of email/sms sending timeframe in [DT: ] format, interpreted in workflow time zone

UseWorkflowStart
boolean

Start the flow running with enrolled participants at the given time

WorkflowStart
string

When to start running the workflow. Until start, any enrolled members are not running through the flow, just waiting. In [DT: ] format, interpreted in workflow time zone

UseEnrollmentEnd
boolean

End enrollment into the workflow at the given time

EnrollmentEnd
string

Do not enroll more participant after given time. In [DT: ] format, interpreted in workflow time zone

RemoveFromFlows
integer<int32>[]

Workflows to remove the participants from when they are enrolled in this workflow

TzLocation
object
Folder
object

Folder structures Carrier object for HierarchyEntity. Services for the HierarchyEntity Carrier is available from the List Agent.

Associate
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

ShipmentType
object

Carrier object for MDOListItem. Services for the MDOListItem Carrier is available from the MDO Agent.

Steps
object[]

The steps in the workflow, mainline steps - forking steps are indicated by its WorkflowStepType.

Triggers
object[]

The triggers for the workflow.

Goals
object[]

The goals for the workflow.

Filter
object

Workflow filter carrier Carrier object for WorkflowFilter. Services for the WorkflowFilter Carrier is available from the Workflow Agent.

BlockLists
integer<int32>[]

Persons in the given selections are not allowed to enter this workflow

ContentInfo
object[]

Info about workflow content like messages, links and forms (read-only)

ExitFlowId
integer<int32>

On exit with no success criteria met, we attempt to add the participant to the given flow

ExitSuccessFlowId
integer<int32>

On exit with success criteria met, we attempt to add the participant to the given flow

CreatedBy
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

UpdatedBy
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

CreatedDate
string<date-time>

Registered date in UTC.

UpdatedDate
string<date-time>

Updated date in UTC.

VisibleFor
object[]

The set of users or groups the record is visible for

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.