POST Agents/Workflow/GetEmailFlow

• 8 minutes to read
 • 8 minutes to read 
POST /api/v1/Agents/Workflow/GetEmailFlow

Gets a EmailFlow object.

NsApiSlow threshold: 2000 ms.

Query String Parameters

Parameter Name Type Description
emailFlowId int32 Required The identifier of the EmailFlow object
$select string 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. 
POST /api/v1/Agents/Workflow/GetEmailFlow?emailFlowId=729
POST /api/v1/Agents/Workflow/GetEmailFlow?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:

OK

Response Description
200 OK

Response body: EmailFlow

Property Name Type Description
EmailFlowId int32 Primary key
Name string Name of the workflow
Description string Description of the workflow
Status string Status of the workflow definition
JumpToFinish bool When a goal is reached, contact jumps directly to finished
StartOnlyOnce bool A contact can start this flow only once
OverrideConsentSubscription bool Override consent and subscription
FromType string Email/Mailing From field address algorithm
FromName string Email From name
FromAddr string Email From address: name@domain.com
ReplyToType string Email/Mailing Reply-To field address algorithm
ReplyToAddr string Reply to address, if different from From-address
ReplyToName string Email Reply-To name
SmsSender string SMS sender (number or name)
UseGoogleAnalytics bool Use Google Analytics
GaSource string GA Source
GaCampaign string GA Campaign
UseTimeframe bool Use sender timeframe settings, only send email/sms within the timeframe
SelectedDays string Selected days (flags, so several days can be selected) for time frame
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 bool 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 bool 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 array Workflows to remove the participants from when they are enrolled in this workflow
TzLocation TimeZoneData The workflow timezone setting
Folder HierarchyEntity The folder/hierarchy the email flow is in. Use MDO List name "hierarchy" to get list items.
Associate Associate The owner of the workflow. Use MDO List name "associate" to get list items.
ShipmentType MDOListItem The Shipment type (mailing type)
Steps array The steps in the workflow, mainline steps - forking steps are indicated by its WorkflowStepType.
Triggers array The triggers for the workflow.
Goals array The goals for the workflow.
Filter WorkflowFilter The filter for the workflow.
BlockLists array Persons in the given selections are not allowed to enter this workflow
ContentInfo array Info about workflow content like messages, links and forms (read-only)
ExitFlowId int32 On exit with no success criteria met, we attempt to add the participant to the given flow
ExitSuccessFlowId int32 On exit with success criteria met, we attempt to add the participant to the given flow
CreatedBy Associate The associate that first created the flow. The property is read-only.
UpdatedBy Associate The person that last updated the flow.
CreatedDate date-time Registered date in UTC.
UpdatedDate date-time Updated date in UTC.
VisibleFor array The set of users or groups the record is visible for
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/Workflow/GetEmailFlow
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "EmailFlowId": 1,
  "Name": "New Customer Welcome Campaign",
  "Description": "Automated welcome email series for new customers with onboarding information and product tips",
  "Status": "Active",
  "JumpToFinish": false,
  "StartOnlyOnce": true,
  "OverrideConsentSubscription": false,
  "FromType": "FromOnlySpecified",
  "FromName": "Customer Success Team",
  "FromAddr": "success@acmecorp.com",
  "ReplyToType": "ReplyToOnlySpecified",
  "ReplyToAddr": "support@acmecorp.com",
  "ReplyToName": "Acme Support",
  "SmsSender": "AcmeCorp",
  "UseGoogleAnalytics": true,
  "GaSource": "email_campaign",
  "GaCampaign": "welcome_series_2024",
  "UseTimeframe": true,
  "SelectedDays": "Monday,Tuesday,Wednesday,Thursday,Friday",
  "TimeframeStart": "09:00",
  "TimeframeEnd": "17:00",
  "UseWorkflowStart": true,
  "WorkflowStart": "2024-01-01T00:00:00",
  "UseEnrollmentEnd": false,
  "EnrollmentEnd": "",
  "RemoveFromFlows": [
    5,
    12
  ],
  "TzLocation": null,
  "Folder": null,
  "Associate": null,
  "ShipmentType": null,
  "Steps": [
    {
      "WorkflowStepId": 1,
      "WorkflowId": 1,
      "StepType": "SendEmail",
      "Rank": 1
    },
    {
      "WorkflowStepId": 2,
      "WorkflowId": 1,
      "StepType": "Wait",
      "Rank": 2
    }
  ],
  "Triggers": [
    {
      "WorkflowTriggerId": 1,
      "WorkflowId": 1,
      "TriggerType": "ContactCreated",
      "RestrictionGroups": [
        {},
        {}
      ],
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 188
        }
      }
    },
    {
      "WorkflowTriggerId": 453,
      "WorkflowId": 651,
      "TriggerType": "AddedMessage",
      "RestrictionGroups": [
        {},
        {}
      ],
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 188
        }
      }
    }
  ],
  "Goals": [
    {
      "WorkflowGoalId": 1,
      "WorkflowId": 1,
      "GoalType": "LinkClicked",
      "RestrictionGroups": [
        {},
        {}
      ],
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 291
        }
      }
    },
    {
      "WorkflowGoalId": 766,
      "WorkflowId": 655,
      "GoalType": "AddedToProject",
      "RestrictionGroups": [
        {},
        {}
      ],
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 291
        }
      }
    }
  ],
  "Filter": null,
  "BlockLists": [
    76,
    910
  ],
  "ContentInfo": [
    {
      "WorkflowContentType": "Email",
      "Id": 101,
      "Actions": true,
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 826
        }
      }
    },
    {
      "WorkflowContentType": "Form",
      "Id": 25,
      "Actions": true,
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 826
        }
      }
    }
  ],
  "ExitFlowId": 0,
  "ExitSuccessFlowId": 0,
  "CreatedBy": null,
  "UpdatedBy": null,
  "CreatedDate": "2024-01-15T10:00:00+01:00",
  "UpdatedDate": "2024-11-28T14:30:00+01:00",
  "VisibleFor": [
    {
      "VisibleId": 780,
      "Visibility": "All",
      "DisplayValue": "doloremque",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 218
        }
      }
    },
    {
      "VisibleId": 780,
      "Visibility": "All",
      "DisplayValue": "doloremque",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 218
        }
      }
    }
  ],
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 123
    }
  }
}