--- updatedAt: 2026-05-26T23:29:16.000Z agentTools: projectIndex: https://docs.lytics.com/llms.txt --- # DotmailerMultiSegExport: Create job Create a DotmailerMultiSegExport job # OpenAPI definition ```json { "components": { "schemas": { "lioerrors.ApiV2ErrorOut": { "properties": { "code": { "description": "Lytics Error Code", "enum": [ "UNKNOWN-000", "BADREQ-001", "JOB-BADREQ-002", "NOTFOUND-003", "JOB-NOTFOUND-004", "WF-NOTFOUND-005", "AUTH-NOTFOUND-006", "AUTHTYPE-NOTFOUND-007", "AUTH-BADREQ-008", "TABLE-NOTFOUND-009", "SCHEMA-NOTFOUND-010", "SCHEMAVERSION-NOTFOUND-011", "ENTITY-NOTFOUND-012", "QUERY-NOTFOUND-013", "STREAM-NOTFOUND-014", "PROVIDER-BADREQ-015", "PROVIDER-NOTFOUND-016", "UNAUTHORIZED-017", "SCHEMA-INVALID-018", "INTERNAL-019", "ROUTERULE-NOTFOUND-020", "ACCOUNT-NOTFOUND-021", "JOB-FAULT-022", "USER-NOTFOUND-023", "USER-BADREQ-024", "JSON-BADREQ-025", "FORBIDDEN-026" ], "type": "string" }, "level": { "description": "When the error was generated", "type": "string" }, "message": { "description": "A description of the error that occurred", "type": "string" }, "timestamp": { "description": "The time the error occurred", "format": "date-time", "type": "string" } }, "type": "object" }, "models.AnomalyRuleResp": { "properties": { "aid": { "type": "integer" }, "checks": { "items": { "$ref": "#/components/schemas/models.RuleCheckConfigReq" }, "type": "array" }, "created": { "type": "string" }, "id": { "type": "string" }, "subject_id": { "type": "string" }, "subject_type": { "type": "string" }, "updated": { "type": "string" } }, "type": "object" }, "models.ApiErrorResponse": { "properties": { "errors": { "description": "Lytics API Errors", "items": { "$ref": "#/components/schemas/lioerrors.ApiV2ErrorOut" }, "type": "array" }, "request_id": { "type": "string" }, "status": { "description": "HTTP Status Code", "type": "integer" } }, "type": "object" }, "models.ApiResponse": { "properties": { "_meta": { "additionalProperties": true, "description": "Response Metadata", "type": "object" }, "data": { "description": "Response Payload", "type": "object" }, "request_id": { "type": "string" }, "status": { "description": "HTTP Status Code", "type": "integer" } }, "type": "object" }, "models.DotmailerMultiSegExport": { "properties": { "backfill_only": { "description": "Select this to do a one time export of the selected audiences", "type": "boolean" }, "collection_id": { "description": "Content collection to include recommendations from - if not selected, no recommendations are sent to dotdigital", "type": "string" }, "email_field": { "description": "Field that contains the contact's email", "type": "string" }, "email_type": { "description": "The type of emails these contacts can receive", "type": "string" }, "exit_action": { "description": "The action to take when an entity exits the audience. Note: Unsubscribing will significantly increase API usage", "type": "string" }, "field_changes": { "description": "Select up to 75 user fields to trigger user change events. For any user in the exported audience, if any of the selected field values change, then the user will be updated in dotdigital.", "items": { "type": "string" }, "type": "array" }, "id_field": { "description": "Field that contains the contact's dotdigital ID. This may be a map field if importing users from multiple accounts", "type": "string" }, "insight_fields": { "description": "Select the Lytics user fields you would like to send to the lytics_fields insight collection in dotdigital. Insight data supports complex data types like arrays and maps", "items": { "type": "string" }, "type": "array" }, "insight_recommendations": { "description": "Select to add content recommendations for users to the lytics_recommendations insight collection in dotdigital", "type": "boolean" }, "mappings": { "description": "Map all the fields from Lytics to dotdigital by selecting the Lytics field on the left, and its dotdigital destination on the right. NOTE: Complex fields such as sets and maps are not supported by dotdigital.", "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" }, "opt_in_type": { "description": "Opt-in type for the contacts that will be created; see [dotdigital documentation](https://support.dotdigital.com/hc/en-gb/articles/212212098-Explaining-contact-opt-in-types) for details", "type": "string" }, "recommender_mappings": { "description": "Map all the recommender fields from Lytics to dotdigital by selecting the Lytics field on the left, and its dotdigital destination on the right. NOTE: Complex fields such as sets and maps are not supported by contact fields. This field is required if a Content Collection is set and Insight Recommendations is not set", "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" }, "resubscribe": { "description": "Contacts will be resubscribed to address books. Address-book level resubscribes are only supported for exports triggering join actions", "type": "boolean" }, "resubscribe_no_challenge": { "description": "Contacts will be resubscribed to address books without triggering a confirmation email. Address-book level resubscribes are only supported for exports triggering join actions. Bulk exports will only resubscribe contacts if they have been suppressed at the account level", "type": "boolean" }, "seg_mappings": { "description": "Map all Lytics Audiences to dotdigital address books by selecting the Lytics audience on the left, and its dotdigital destination on the right", "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" }, "segment_ids": { "description": "Which Lytics Audience(s) to export to dotdigital", "items": { "type": "string" }, "type": "array" }, "trigger_join": { "description": "Contacts will trigger join actions when added to the address book. Note: Selecting this will significantly increase API usage", "type": "boolean" } }, "type": "object" }, "models.JobRequest": { "properties": { "auth_ids": { "description": "Authorization IDs associated with the Job", "items": { "type": "string" }, "type": "array" }, "config": { "description": "Job configuration, unique per-workflow", "type": "object" }, "description": { "description": "A user-defined description", "type": "string" }, "drop_events_during_quiet_window": { "type": "boolean" }, "expires_at": { "format": "date-time", "type": "string" }, "monitoring": { "description": "Inline monitoring config. On write: omit to keep, null to clear, or a config to set.", "type": "object" }, "name": { "description": "A user-defined name", "type": "string" }, "quiet_period": { "type": "integer" }, "quiet_time_of_day": { "type": "string" }, "quiet_timezone": { "type": "string" } }, "required": [ "config", "name" ], "type": "object" }, "models.JobResponse": { "properties": { "account_id": { "description": "Lytics Account ID", "type": "string" }, "anomaly_rule": { "$ref": "#/components/schemas/models.AnomalyRuleResp" }, "api_token_auth_id": { "description": "this is set when work is create using access token", "type": "string" }, "auth_ids": { "description": "Authorization IDs associated with the Job", "items": { "type": "string" }, "type": "array" }, "config": { "description": "Job configuration, unique per-workflow", "type": "object" }, "created": { "type": "string" }, "deleted": { "description": "The Job has been deleted", "type": "boolean" }, "description": { "description": "A user-defined description", "type": "string" }, "drop_events_during_quiet_window": { "type": "boolean" }, "expires_at": { "format": "date-time", "type": "string" }, "id": { "description": "A Lytics-assigned, immutable unique ID for the Job", "type": "string" }, "meta": { "additionalProperties": true, "description": "Extra meta data about the job", "type": "object" }, "monitoring": { "description": "Inline monitoring config. On write: omit to keep, null to clear, or a config to set.", "type": "object" }, "name": { "description": "A user-defined name", "type": "string" }, "quiet_period": { "type": "integer" }, "quiet_time_of_day": { "type": "string" }, "quiet_timezone": { "type": "string" }, "sleep_until": { "type": "string" }, "status": { "description": "The status of the job", "enum": [ "runnable", "sleeping", "paused", "completed", "fault", "failed", "killed", "deleted", "unknown" ], "type": "string" }, "updated": { "type": "string" }, "user_id": { "description": "The user ID that created or updated the job", "type": "string" }, "workflow": { "description": "The workflow slug", "type": "string" }, "workflow_id": { "description": "The workflow ID", "type": "string" } }, "required": [ "config", "name" ], "type": "object" }, "models.RuleCheckConfigReq": { "properties": { "allowable_violations": { "type": "integer" }, "interval": { "type": "string" }, "lookback_count": { "type": "integer" }, "max_threshold": { "type": "integer" }, "metric_type": { "type": "string" }, "min_threshold": { "type": "integer" }, "type": { "type": "string" }, "variance_pct": { "type": "number" } }, "type": "object" } }, "securitySchemes": { "ApiKeyAuth": { "in": "header", "name": "Authorization", "type": "apiKey" } } }, "info": { "contact": { "email": "support@lytics.com", "name": "Lytics Support", "url": "https://support.lytics.com/hc/en-us" }, "description": "Version 2 of the Lytics API", "termsOfService": "https://www.lytics.com/terms-of-service/", "title": "Lytics API", "version": "2.0" }, "openapi": "3.0.3", "paths": { "/job/dotmailer-multi-seg-export": { "post": { "description": "Create a DotmailerMultiSegExport job", "parameters": [ { "description": "The account ID. Defaults to the user's default account.", "in": "query", "name": "account_id", "schema": { "type": "string" } } ], "requestBody": { "content": { "*/*": { "schema": { "allOf": [ { "$ref": "#/components/schemas/models.JobRequest" }, { "properties": { "config": { "$ref": "#/components/schemas/models.DotmailerMultiSegExport" } }, "type": "object" } ] } } }, "description": "The Job Configuration", "required": true, "x-originalParamName": "job" }, "responses": { "201": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/models.ApiResponse" }, { "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/models.JobResponse" }, { "properties": { "config": { "$ref": "#/components/schemas/models.DotmailerMultiSegExport" } }, "type": "object" } ] } }, "type": "object" } ] } } }, "description": "DotmailerMultiSegExport Job" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.ApiErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/models.ApiErrorResponse" } } }, "description": "Internal Server Error" } }, "security": [ { "ApiKeyAuth": [] } ], "summary": "DotmailerMultiSegExport: Create job", "tags": [ "Jobs" ] } } }, "servers": [ { "url": "https://api.lytics.io/v2" } ], "tags": [ { "description": "Create and manage data import and export jobs.", "name": "Jobs" } ] } ```