> ## Documentation Index > Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt > Use this file to discover all available pages before exploring further. # Save Email Flow > Updates the existing EmailFlow or creates a new EmailFlow if the id parameter is 0. NsApiSlow threshold: 2000 ms. ## OpenAPI ````yaml /openapi/agent/openapi-v3-WorkflowAgent.json post /api/v1/Agents/Workflow/SaveEmailFlow openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - WorkflowAgent contact: name: SuperOffice DevNet url: https://docs.superoffice.com/en/api/index.html email: sdk@superoffice.com servers: - url: http://localhost:56350 - url: https://localhost:56350 security: [] tags: [] externalDocs: description: >- The SuperOffice DevNet Community has more documentation, examples, and discussion forums. url: https://community.superoffice.com/en/developer/ paths: /api/v1/Agents/Workflow/SaveEmailFlow: post: tags: - Workflow_Agent summary: Save Email Flow description: >- Updates the existing EmailFlow or creates a new EmailFlow if the id parameter is 0. NsApiSlow threshold: 2000 ms. operationId: v1WorkflowAgent_SaveEmailFlow parameters: - name: Accept-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. required: false schema: type: string - name: SO-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. required: false schema: type: string - name: SO-Culture in: header description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. required: false schema: type: string - name: SO-TimeZone in: header description: >- Specify the timezone code that you would like date/time responses converted to. required: false schema: type: string - name: SO-AppToken in: header description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.EmailFlow' text/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.EmailFlow' application/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.EmailFlow' text/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.EmailFlow' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.EmailFlow' application/json-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.EmailFlow' application/merge-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.EmailFlow' description: The EmailFlow that is saved required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.EmailFlow' text/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.EmailFlow' application/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.EmailFlow' text/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.EmailFlow' application/json-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.EmailFlow' application/merge-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.EmailFlow' security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.CRM.Services.EmailFlow: description: "Email flow carrier\r\n\r\nCarrier object for EmailFlow.\r\nServices for the EmailFlow Carrier is available from the Workflow Agent." type: object properties: EmailFlowId: format: int32 description: Primary key type: integer Name: description: Name of the workflow type: string Description: description: Description of the workflow type: string Status: description: Status of the workflow definition enum: - None - Stopped - Paused - Running type: string JumpToFinish: description: When a goal is reached, contact jumps directly to finished type: boolean StartOnlyOnce: description: A contact can start this flow only once type: boolean OverrideConsentSubscription: description: Override consent and subscription type: boolean FromType: description: Email/Mailing From field address algorithm enum: - FromOnlySpecified - FromSalesContact - FromSupportContact type: string FromName: description: Email From name type: string FromAddr: description: 'Email From address: name@domain.com' type: string ReplyToType: description: Email/Mailing Reply-To field address algorithm enum: - ReplyToOnlySpecified - ReplyToSalesContact - ReplyToSupportContact - ReplyToEmpty type: string ReplyToAddr: description: Reply to address, if different from From-address type: string ReplyToName: description: Email Reply-To name type: string SmsSender: description: SMS sender (number or name) type: string UseGoogleAnalytics: description: Use Google Analytics type: boolean GaSource: description: GA Source type: string GaCampaign: description: GA Campaign type: string UseTimeframe: description: >- Use sender timeframe settings, only send email/sms within the timeframe type: boolean SelectedDays: description: >- Selected days (flags, so several days can be selected) for time frame enum: - Unknown - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday type: string TimeframeStart: description: >- Start of email/sms sending timeframe in [DT: ] format, interpreted in workflow time zone type: string TimeframeEnd: description: >- End of email/sms sending timeframe in [DT: ] format, interpreted in workflow time zone type: string UseWorkflowStart: description: Start the flow running with enrolled participants at the given time type: boolean WorkflowStart: description: >- 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 type: string UseEnrollmentEnd: description: End enrollment into the workflow at the given time type: boolean EnrollmentEnd: description: >- Do not enroll more participant after given time. In [DT: ] format, interpreted in workflow time zone type: string RemoveFromFlows: description: >- Workflows to remove the participants from when they are enrolled in this workflow type: array items: format: int32 type: integer TzLocation: $ref: '#/components/schemas/SuperOffice.CRM.TimeZoneData' Folder: $ref: '#/components/schemas/SuperOffice.CRM.Services.HierarchyEntity' Associate: $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate' ShipmentType: $ref: '#/components/schemas/SuperOffice.CRM.Services.MDOListItem' Steps: description: >- The steps in the workflow, mainline steps - forking steps are indicated by its WorkflowStepType. type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.WorkflowStepBase' Triggers: description: The triggers for the workflow. type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.WorkflowTrigger' Goals: description: The goals for the workflow. type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.WorkflowGoal' Filter: $ref: '#/components/schemas/SuperOffice.CRM.Services.WorkflowFilter' BlockLists: description: >- Persons in the given selections are not allowed to enter this workflow type: array items: format: int32 type: integer ContentInfo: description: >- Info about workflow content like messages, links and forms (read-only) type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.WorkflowContentInfo' ExitFlowId: format: int32 description: >- On exit with no success criteria met, we attempt to add the participant to the given flow type: integer ExitSuccessFlowId: format: int32 description: >- On exit with success criteria met, we attempt to add the participant to the given flow type: integer CreatedBy: $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate' UpdatedBy: $ref: '#/components/schemas/SuperOffice.CRM.Services.Associate' CreatedDate: format: date-time description: Registered date in UTC. type: string UpdatedDate: format: date-time description: Updated date in UTC. type: string VisibleFor: description: The set of users or groups the record is visible for type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.VisibleFor' TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.TimeZoneData: type: object properties: TZLocationID: format: int32 description: Timezone location ID - primary key. type: integer Name: description: >- Name associated with the location: Country name + region name, Norway, United States - Alaska type: string TZLocationCode: description: "Code associated with location: UTC, AR-NQ, AU-QLD, PF2A\r\nNot the an ISO country code. Unique." type: string TZLocationCities: description: 'Cities associated with location: Oslo, London, Rio de Janeiro' type: string IsoNumber: format: int32 description: 'Country ISO code associated with location: 578' type: integer TimeZoneSTDRules: description: Dictionary of standard rules type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.TimeZoneRule' TimeZoneDSTRules: description: Dictionary of Daylight saving time rules type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.TimeZoneRule' SuperOffice.CRM.Services.HierarchyEntity: description: "Folder structures\r\n\r\nCarrier object for HierarchyEntity.\r\nServices for the HierarchyEntity Carrier is available from the List Agent." type: object properties: HierarchyId: format: int32 description: The primary key (auto-incremented) type: integer Domain: description: Domain seperating the different hierarchy enum: - Unknown - ExtraTables - ScreenDefinitions - Scripts - Selections - ExternalDocuments - UserGroups - ExternalDocumentRelatedToSpmMessage - Dashboards - EmailFlows type: string Name: description: Name of this hierarchy folder. type: string Fullname: description: The full name of this category, i.e. Foo/bar/test. type: string ParentId: format: int32 description: Parent table type: integer Children: description: Sub-items, if any. type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.HierarchyEntity' Registered: format: date-time description: Registered when in UTC. type: string RegisteredAssociateId: format: int32 description: Registered by whom type: integer Updated: format: date-time description: Last updated when in UTC. type: string UpdatedAssociateId: format: int32 description: Last updated by whom type: integer TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.Associate: description: "Carrier object for Associate.\r\nServices for the Associate Carrier is available from the Associate Agent." type: object properties: AssociateId: format: int32 description: Primary key type: integer Name: description: Initials, also login name, possibly database user name type: string PersonId: format: int32 description: "Owning person record \r\nUse MDO List name \"person\" to get list items." type: integer Rank: format: int32 description: Rank order type: integer Tooltip: description: Tooltip or other description type: string Type: description: >- User type - 1 = internal user, 2 = resource, 3 = external user, 4 = anonymous, 5 = system enum: - Unknown - InternalAssociate - ResourceAssociate - ExternalAssociate - AnonymousAssociate - SystemAssociate type: string GroupIdx: format: int32 description: >- Primary group membership, see UserGroupLink for secondary memberships type: integer FullName: description: >- The associate's culture formatted fullname (firstname, middleName and lastname) type: string FormalName: description: >- The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs) type: string Deleted: description: >- If true, the user is retired and should have no rights, not appear in lists, etc. type: boolean EjUserId: format: int32 description: >- ID of the ej user record corresponding to this associate; 0 for associates that are not ej users type: integer UserName: description: User name type: string ExtraFields: description: "Deprecated: Use {SuperOffice.CRM.Services.Associate.CustomFields} instead.\r\nExtra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc." type: object additionalProperties: type: string CustomFields: description: "Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin.\r\nCustom fields combines user defined fields and extra fields into one bucket. \r\nThe individual {SuperOffice.CRM.Services.Associate.ExtraFields} and UserDefinedFields properties are deprecated in favor of this\r\ncombined collection." type: object additionalProperties: type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.MDOListItem: description: "Carrier object for MDOListItem.\r\nServices for the MDOListItem Carrier is available from the MDO Agent." type: object properties: Id: format: int32 description: The Id of the ListItem type: integer Name: description: The name of the ListItem type: string ToolTip: description: The tooltip of the ListItem type: string Deleted: description: The deleted status of the ListItem type: boolean Rank: format: int32 description: The rank of the ListItem type: integer Type: description: The type of the ListItem. Custom field. type: string ChildItems: description: The child items of the MDOListItem type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.MDOListItem' IconHint: description: The Icon hint of the ListItem. Custom field. type: string ColorBlock: format: int32 description: The color indicator of the ListItem color block type: integer ExtraInfo: description: >- Extra information added to the ListItem. Could be information such as sort order etc or other meta data. Custom field. type: string StyleHint: description: >- Style hint indicating, information such as background color etc. Custom field. type: string FullName: description: The name of the ListItem in its context type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.WorkflowStepBase: description: "Workflow step carrier.\r\n\r\nCarrier object for WorkflowStepBase.\r\nServices for the WorkflowStepBase Carrier is available from the Workflow Agent." type: object properties: WorkflowStepId: format: int32 description: Primary key type: integer WorkflowId: format: int32 description: The workflow to connect to type: integer StepType: description: Step type enum: - None - SendEmail - SendSMS - WaitForTime - WaitForAction - Split - UpdateParticipant - AddToList - RemoveFromList - CreateRequest - CreateFollowUp - CreateSale - NotifyByEmail - NotifyBySMS - RunScript - DistributeToOwner type: string Rank: format: int32 description: Step order type: integer SuperOffice.CRM.Services.WorkflowTrigger: description: "Workflow trigger carrier\r\n\r\nCarrier object for WorkflowTrigger.\r\nServices for the WorkflowTrigger Carrier is available from the Workflow Agent." type: object properties: WorkflowTriggerId: format: int32 description: Primary key type: integer WorkflowId: format: int32 description: The flow this trigger belongs to type: integer TriggerType: description: The workflow trigger type enum: - None - PersonCreated - PersonUpdated - AddedToProject - CreatedRequest - LinkClicked - AddedToSelection - FormSubmitted - AddedMessage - StartedChat - OrderPlaced - SaleCreated - SaleSold - SaleLost type: string RestrictionGroups: description: >- The restrictions (can be multiple groups) that make up the Workflow trigger criteria type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.ArchiveLists.ArchiveRestrictionGroup TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.WorkflowGoal: description: "Workflow goal carrier\r\n\r\nCarrier object for WorkflowGoal.\r\nServices for the WorkflowGoal Carrier is available from the Workflow Agent." type: object properties: WorkflowGoalId: format: int32 description: Primary key type: integer WorkflowId: format: int32 description: The flow this goal belongs to type: integer GoalType: description: The workflow goal type enum: - None - PersonUpdated - SaleCreatedOnPerson - SaleCreatedOnCompany - AppointmentCreated - AddedToProject - AddedToSelection - FormSubmitted - HadChat - LinkClicked - RequestCreated type: string RestrictionGroups: description: >- The restrictions (can be multiple groups) that make up the Workflow goal criteria type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.ArchiveLists.ArchiveRestrictionGroup TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.WorkflowFilter: description: "Workflow filter carrier\r\n\r\nCarrier object for WorkflowFilter.\r\nServices for the WorkflowFilter Carrier is available from the Workflow Agent." type: object properties: RestrictionGroups: description: >- The restrictions (can be multiple groups) that make up the Workflow filter type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.ArchiveLists.ArchiveRestrictionGroup TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.WorkflowContentInfo: description: "Info about workflow content like messages, forms and links.\r\n\r\nCarrier object for WorkflowContentInfo.\r\nServices for the WorkflowContentInfo Carrier is available from the Workflow Agent." type: object properties: WorkflowContentType: description: The workflow content type enum: - None - Message - Form - Link type: string Id: format: int32 description: The id of the content row. type: integer Actions: description: True if the content (form, link) have associated actions. type: boolean TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.VisibleFor: description: "Carrier object for VisibleFor.\r\nServices for the VisibleFor Carrier is available from the Sentry Agent." type: object properties: VisibleId: format: int32 description: '' type: integer Visibility: description: '' enum: - All - Associate - Group type: string DisplayValue: description: '' type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Security.TableRight: description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted." type: object properties: Mask: type: string Reason: type: string SuperOffice.CRM.Security.FieldProperty: description: >- Class holding properties like field length, field type about a field in the carrier. type: object properties: FieldRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight' FieldType: type: string FieldLength: format: int32 description: '' type: integer SuperOffice.CRM.TimeZoneRule: type: object properties: StartDay: format: int32 type: integer StartMonth: format: int32 type: integer EndDay: format: int32 type: integer EndMonth: format: int32 type: integer TZOffset: format: int32 type: integer StartRulePattern: type: string EndRulePattern: type: string SuperOffice.CRM.ArchiveLists.ArchiveRestrictionGroup: description: This class carries information about a group of restrictions type: object properties: Name: description: Name of the group type: string Description: description: Description of the group type: string Rank: format: int32 description: Rank of group among groups type: integer Restrictions: type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.ArchiveLists.ArchiveRestrictionInfo SuperOffice.CRM.Security.FieldRight: description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined." type: object properties: Mask: type: string Reason: type: string SuperOffice.CRM.ArchiveLists.ArchiveRestrictionInfo: description: >- This class carries information about a restriction on the query of an archive provider type: object properties: Name: description: The programmatic column name, including any required prefixes type: string Operator: description: The operator, such as =, etc type: string Values: description: Value(s) to test against type: array items: type: string DisplayValues: description: "Display representation of value(s) - list ID's are decoded to display texts, other values are represented in a format\r\nsuitable for decoding and display through the {SuperOffice.CRM.Globalization.CultureDataFormatter}." type: array items: type: string ColumnInfo: $ref: '#/components/schemas/SuperOffice.CRM.ArchiveLists.ArchiveColumnInfo' IsActive: description: >- Is this restriction active? Inactive restrictions will not influence the generated query type: boolean SubRestrictions: description: >- Optional collection of sub criteria, usually null but set for Saint counter fields type: array items: $ref: >- #/components/schemas/SuperOffice.CRM.ArchiveLists.ArchiveRestrictionInfo InterParenthesis: format: int32 description: "Get or set the parenthesis (if any) associated with this restriction. Positive values indicate a number\r\nof opening parentheses (deepening nesting level), while negative numbers indicate closing parentheses.\r\nZero means no change in nesting level (no parentheses)." type: integer InterOperator: description: "Get or set the inter-restriction operator that describes how this\r\nrestriction is related to the next one in an array.\r\nDefault for new ArchiveRestrictionInfo objects is And" enum: - None - And - Or type: string UniqueHash: format: int32 type: integer SuperOffice.CRM.ArchiveLists.ArchiveColumnInfo: description: "This class carries information about the definition and properties of an archive display column. It is used by the archive\r\nMDO providers to construct column lists for the configuration dialogs, and by the archive control to know what type\r\n(and other properties) each column has. The class is serializable and used on both the application\r\nand Web server sides." type: object properties: DisplayName: description: The column name to show, can be a resource identifier string type: string DisplayTooltip: description: >- The column tooltip, used in the column list and in the column headings type: string DisplayType: description: "Type of column, so that the archive knows how to display it (actual display values are always strings, invariant-culture formatted).\r\nThis name can contain resource tags." type: string CanOrderBy: description: Can this column be used for sorting? type: boolean Name: description: "Unique identity of this column (in this particular context); the name to be used when requesting the column from a provider,\r\nsetting restrictions or order by criteria" type: string CanRestrictBy: description: Can this column be used as a restriction type: boolean RestrictionType: description: >- The data type of the restriction; use this to retrieve the legal operators for the restriction type: string RestrictionListName: description: >- If the restriction data type is 'list', this property contains the name of the SoList so that choices can be shown type: string IsVisible: description: Is this column visible to the user in configuration dialogs etc type: boolean ExtraInfo: description: >- Example: "navigator" -> Should this column be mapped to a hyperlinked navigator text type? type: string Width: description: "The width specification, if the column info has been extended with GUI-based information.\r\nIt is either \"n%\" or \"nc\", where n is an integer. Percent-formatted fields grow and shrink; number-of-characters\r\nformatted fields have constant width when the whole archive width changes." type: string IconHint: description: "Icon hint corresponding to the display name; this icon hint is used in the configuration dialog\r\nand other places where we 'talk about' the columns of the archive. The actual heading\r\nof the archive may also contain icons in lieu of textual names, the icon hint for that\r\nis specified in {SuperOffice.CRM.ArchiveLists.ArchiveColumnInfo.HeadingIconHint} and is a different one." type: string HeadingIconHint: description: "Icon hint for the archive heading only. If this is a nonempty string, the archive header\r\nshould use this icon and ignore the {SuperOffice.CRM.ArchiveLists.ArchiveColumnInfo.DisplayName}. Otherwise, the DisplayName\r\nshould be used as the heading." type: string ```` ## Related topics - [Save email flow](/en/api/web-services/howto/flows/rest-save-flow.md) - [NSWorkflowAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSWorkflowAgent.md) - [SuperOffice.WebApi.Agents.IWorkflowAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IWorkflowAgent.md) - [SuperOffice.WebApi.Agents.WorkflowAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.WorkflowAgent.md) - [Flow content](/en/marketing/flows/learn/content.md) - [EmailFlows](/en/api/archive-providers/reference/emailflows.md)