> ## 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.
# Export group members to an SFTP server
> Starts an asynchronous CSV export of the group members to the SFTP server of a Credential Store entry. Credentials are never passed in the request. Track completion with process/getDetails.
Request body example:
{
"credentialId" : 42,
"listType" : "ACTIVE",
"standardAttributes" : ["user.Email"],
"namedAttributes" : ["*"],
"format" : "CSV"
}
## OpenAPI
````json POST /group/exportToServer
{
"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": {
"/group/exportToServer": {
"post": {
"tags": [
"Group"
],
"summary": "Export group members to an SFTP server",
"description": "Starts an asynchronous CSV export of the group members to the SFTP server of a Credential Store entry. Credentials are never passed in the request. Track completion with process/getDetails.{
\"credentialId\" : 42,
\"listType\" : \"ACTIVE\",
\"standardAttributes\" : [\"user.Email\"],
\"namedAttributes\" : [\"*\"],
\"format\" : \"CSV\"
}",
"operationId": "exportToServer",
"parameters": [
{
"name": "groupId",
"in": "query",
"description": "ID of the group to export",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"description": "Export options",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupExportOptions"
}
}
},
"required": true,
"x-bodyName": "body"
},
"responses": {
"200": {
"description": "The export process id and initial status.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GroupExportJobResult"
}
}
}
},
"400": {
"description": "A parameter is invalid, an attribute is unknown or the credential is not an SFTP account.",
"content": {
"application/json": {}
}
},
"404": {
"description": "The group or credential does not exist or is not visible to the caller.",
"content": {
"application/json": {}
}
}
}
}
}
},
"components": {
"schemas": {
"GroupExportOptions": {
"type": "object",
"properties": {
"credentialId": {
"type": "integer",
"format": "int64"
},
"listType": {
"type": "string"
},
"standardAttributes": {
"type": "array",
"items": {
"type": "string"
}
},
"namedAttributes": {
"type": "array",
"items": {
"type": "string"
}
},
"memberAttributes": {
"type": "array",
"items": {
"type": "string"
}
},
"format": {
"type": "string"
},
"encoding": {
"type": "string"
},
"fileName": {
"type": "string"
},
"compress": {
"type": "boolean",
"default": false
}
}
},
"GroupExportJobResult": {
"type": "object",
"properties": {
"processId": {
"type": "integer",
"format": "int64"
},
"status": {
"enum": [
"FAILED",
"FINISHED",
"PAUSED",
"PROCESSING"
],
"type": "string"
}
}
}
}
}
}
````