Skip to content

Create Export Activity Job

POST /bulk/v1/activities/export/create.json

Permissions Read-Only Activity

Build a request and mock the response

Method: POST
Path: /bulk/v1/activities/export/create.json
Tag: Bulk Export Activities
Operation ID: createExportActivitiesUsingPOST

Create export job for search criteria defined via "filter" parameter. Request returns the "exportId" which is passed as a parameter in subsequent calls to Bulk Export Activities endpoints. Use Enqueue Export Activity Job endpoint to queue the export job for processing. Use Get Export Activity Job Status endpoint to retrieve status of export job. Required Permissions: Read-Only Activity

Formats

  • Request: application/json
  • Response: application/json

Request

Request body

Name: exportActivityRequest
Required: No
Schema: model: ExportActivityRequest

exportActivityRequest

ColumnHeaderNames: A JSON object containing key-value pairs of field and column header names.

Example:
"columnHeaderNames":{
"primaryAttributeValueId":"Attribute ID",
"primaryAttributeValue":"Attribute Value",
"attributes":"Secondary Attributes"
}

Generated example

{
  "columnHeaderNames": {
    "name": "Example name",
    "value": "string"
  },
  "fields": [
    "string"
  ],
  "filter": {
    "activityTypeIds": [
      123
    ],
    "primaryAttributeValueIds": [
      123
    ],
    "primaryAttributeValues": [
      "string"
    ],
    "createdAt": {
      "endAt": "string",
      "startAt": "string"
    }
  },
  "format": "string"
}

Referenced models

Example request

POST {{base_url}}/bulk/v1/activities/export/create.json
Content-Type: application/json
Accept: application/json

{
  "columnHeaderNames": {
    "name": "Example name",
    "value": "string"
  },
  "fields": [
    "string"
  ],
  "filter": {
    "activityTypeIds": [
      123
    ],
    "primaryAttributeValueIds": [
      123
    ],
    "primaryAttributeValues": [
      "string"
    ],
    "createdAt": {
      "endAt": "string",
      "startAt": "string"
    }
  },
  "format": "string"
}

Responses

200 — OK

Schema: model: ResponseOfExportResponse

Generated example

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "requestId": "123",
  "result": [
    {
      "createdAt": "2026-01-15T10:30:00Z",
      "errorMsg": "string",
      "exportId": "123",
      "fileSize": 123,
      "fileChecksum": "string",
      "finishedAt": "2026-01-15T10:30:00Z",
      "format": "string",
      "numberOfRecords": 123,
      "queuedAt": "2026-01-15T10:30:00Z",
      "startedAt": "2026-01-15T10:30:00Z",
      "status": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 123,
      "message": "string"
    }
  ]
}

Referenced models

Source

Generated from swagger-mapi.json.

Generated examples are inferred from the schema. They are illustrative and may not be valid production payloads.