> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mapp.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Transfer a published segment plan

> Transfers every matching contact from a published segment plan into an existing or newly created group. Supply groupId for an existing group, or omit it and supply groupName and groupEmail to create a group.

## OpenAPI

````json POST /segmentation/transfer
{
  "openapi": "3.0.4",
  "info": {
    "title": "Engage public API",
    "version": "1"
  },
  "servers": [
    {
      "url": "https://your-engage-domain.com/api/rest"
    }
  ],
  "tags": [
    {
      "name": "Address Attributes"
    },
    {
      "name": "Async"
    },
    {
      "name": "Audit Log"
    },
    {
      "name": "Automation"
    },
    {
      "name": "Blacklist"
    },
    {
      "name": "CMS"
    },
    {
      "name": "Contact"
    },
    {
      "name": "Content"
    },
    {
      "name": "Coupon"
    },
    {
      "name": "Draft Message"
    },
    {
      "name": "Ecommerce"
    },
    {
      "name": "Group"
    },
    {
      "name": "Group Attributes"
    },
    {
      "name": "Landing Page"
    },
    {
      "name": "Member Attributes"
    },
    {
      "name": "Membership"
    },
    {
      "name": "Message"
    },
    {
      "name": "Meta"
    },
    {
      "name": "Mobile Push"
    },
    {
      "name": "Prepared Message"
    },
    {
      "name": "Process"
    },
    {
      "name": "Profile Attributes"
    },
    {
      "name": "Related Data"
    },
    {
      "name": "Segmentation"
    },
    {
      "name": "System"
    },
    {
      "name": "System User"
    },
    {
      "name": "Usage Statistics"
    },
    {
      "name": "User"
    },
    {
      "name": "Whiteboard"
    }
  ],
  "paths": {
    "/segmentation/transfer": {
      "post": {
        "tags": [
          "Segmentation"
        ],
        "summary": "Transfer a published segment plan",
        "description": "Transfers every matching contact from a published segment plan into an existing or newly created group. Supply groupId for an existing group, or omit it and supply groupName and groupEmail to create a group.",
        "operationId": "transfer",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "ID of the published segment plan (GUID).",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "groupId",
            "in": "query",
            "description": "Existing target group id. Omit to create a group.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "syncMode",
            "in": "query",
            "description": "Transfer mode: add or replace.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "groupName",
            "in": "query",
            "description": "Name for a new target group. Required when groupId is omitted.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "groupEmail",
            "in": "query",
            "description": "Email address for a new target group. Required when groupId is omitted.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "groupTemplateId",
            "in": "query",
            "description": "Optional settings template id for a new target group.",
            "schema": {
              "type": "integer",
              "format": "int64"
            }
          },
          {
            "name": "useIndividualToAddress",
            "in": "query",
            "description": "Optional individual-to-address setting for a new target group.",
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "The target group id and asynchronous process id.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SegmentTransferResult"
                }
              }
            }
          },
          "400": {
            "description": "A parameter is missing or invalid.",
            "content": {
              "application/json": {}
            }
          },
          "404": {
            "description": "The target group does not exist.",
            "content": {
              "application/json": {}
            }
          },
          "500": {
            "description": "The transfer could not be scheduled.",
            "content": {
              "application/json": {}
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "SegmentTransferResult": {
        "type": "object",
        "properties": {
          "groupId": {
            "type": "integer",
            "format": "int64"
          },
          "processId": {
            "type": "integer",
            "format": "int64"
          }
        }
      }
    }
  }
}
````