Get Email Flow
Gets a EmailFlow object.
NsApiSlow threshold: 2000 ms.
Headers
Convert string references and multi-language values into a specified language (iso2) code.
Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
Specify the timezone code that you would like date/time responses converted to.
The application token that identifies the partner app. Used when calling Online WebAPI from a server.
Query Parameters
The identifier of the EmailFlow object
Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.
Response
OK
Email flow carrier Carrier object for EmailFlow. Services for the EmailFlow Carrier is available from the Workflow Agent.
Primary key
Name of the workflow
Description of the workflow
Status of the workflow definition
None, Stopped, Paused, Running When a goal is reached, contact jumps directly to finished
A contact can start this flow only once
Override consent and subscription
Email/Mailing From field address algorithm
FromOnlySpecified, FromSalesContact, FromSupportContact Email From name
Email From address: name@domain.com
Email/Mailing Reply-To field address algorithm
ReplyToOnlySpecified, ReplyToSalesContact, ReplyToSupportContact, ReplyToEmpty Reply to address, if different from From-address
Email Reply-To name
SMS sender (number or name)
Use Google Analytics
GA Source
GA Campaign
Use sender timeframe settings, only send email/sms within the timeframe
Selected days (flags, so several days can be selected) for time frame
Unknown, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday Start of email/sms sending timeframe in [DT: ] format, interpreted in workflow time zone
End of email/sms sending timeframe in [DT: ] format, interpreted in workflow time zone
Start the flow running with enrolled participants at the given time
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
End enrollment into the workflow at the given time
Do not enroll more participant after given time. In [DT: ] format, interpreted in workflow time zone
Workflows to remove the participants from when they are enrolled in this workflow
Folder structures Carrier object for HierarchyEntity. Services for the HierarchyEntity Carrier is available from the List Agent.
Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
Carrier object for MDOListItem. Services for the MDOListItem Carrier is available from the MDO Agent.
The steps in the workflow, mainline steps - forking steps are indicated by its WorkflowStepType.
The triggers for the workflow.
The goals for the workflow.
Workflow filter carrier Carrier object for WorkflowFilter. Services for the WorkflowFilter Carrier is available from the Workflow Agent.
Persons in the given selections are not allowed to enter this workflow
Info about workflow content like messages, links and forms (read-only)
On exit with no success criteria met, we attempt to add the participant to the given flow
On exit with success criteria met, we attempt to add the participant to the given flow
Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
Registered date in UTC.
Updated date in UTC.
The set of users or groups the record is visible for
Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.
Field property dictionary mapping field names to field access rights.
Related topics
NSEmailFlowSave email flowEmailFlowsEmailFlowFoldersEmailFlowEmailContentEmailFlowsAndFolders