Skip to content
Documentation

Create Export

POST
/api/v1/workspaces/{workspace_id}/exports

Creates a new export.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
workspace_id
required
integer

Workspace ID

Request Body

Section titled “Request Body ”
object
connector_id
integer
nullable
email_id
required
integer
export_type
required
string
Allowed values: html connector json pdf
dynamic_content_profile_id
string
nullable
options
required
object
image_mode
string
Allowed values: use_cdn include_in_zip
locales
required
Array<string>
Allowed values: ar-SA bn-BD bn-IN ca-ES cs-CZ da-DK de-AT de-CH de-DE el-GR en-AU en-CA en-GB en-IE en-IN en-NZ en-US en-ZA es-AR es-CL es-CO es-ES es-MX es-US fi-FI fr-BE fr-CA fr-CH fr-FR he-IL hi-IN hu-HU id-ID it-CH it-IT ja-JP ko-KR nl-BE nl-NL no-NO pl-PL pt-BR pt-PT ro-RO ru-RU sk-SK sv-SE ta-IN ta-LK th-TH tr-TR zh-CN zh-HK
folder_id

The ID of the folder to export to

string
campaign_id

The ID of the campaign to export to

string
export_field_values
object
key
additional properties
string
per_locale_options
object
key
additional properties
object
resource_name
string
update_previous_export
boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful

object
id
required
integer
Example
12345
organization_id
required
integer
Example
12345
connector_id
required
integer
nullable
Example
12345
email_id
required
integer
Example
12345
email
required
object
id
integer
Example
12345
name
string
dynamic_content_profile_id
required
string
nullable
Example
a8c5c5c0-5b1a-4b5a-9b0a-5e8b5c5c5c5c
status
required
string
Allowed values: in_progress completed failed
Example
in_progress
export_type
required
string
Allowed values: json html connector pdf
Example
html
options
required
object
image_mode
string
Allowed values: use_cdn include_in_zip
locales
required
Array<string>
Allowed values: ar-SA bn-BD bn-IN ca-ES cs-CZ da-DK de-AT de-CH de-DE el-GR en-AU en-CA en-GB en-IE en-IN en-NZ en-US en-ZA es-AR es-CL es-CO es-ES es-MX es-US fi-FI fr-BE fr-CA fr-CH fr-FR he-IL hi-IN hu-HU id-ID it-CH it-IT ja-JP ko-KR nl-BE nl-NL no-NO pl-PL pt-BR pt-PT ro-RO ru-RU sk-SK sv-SE ta-IN ta-LK th-TH tr-TR zh-CN zh-HK
folder_id

The ID of the folder to export to

string
campaign_id

The ID of the campaign to export to

string
export_field_values
object
key
additional properties
string
per_locale_options
object
key
additional properties
object
resource_name
string
update_previous_export
boolean
integration_name
required
string
nullable
Example
Brevo
metadata
required
object
conditional_ids
Array<integer>
personalization_tag_ids
Array<integer>
image_ids
Array<integer>
export_errors
required
object
base
Array<string>
nullable
additionalProperties
object
key
additional properties
Array<string>
created_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
updated_at
required
string format: date-time
Example
2023-08-23T10:30:00.000Z
download_zip_url
string
Example
https://www.example.com/download.zip
download_json_url
required
string
nullable
Example
https://www.example.com/download.json
open_in_integration_url
required
string
nullable
Example
https://www.example.com/integrations/mailchimp/export/12345

401

Section titled “401 ”

Unauthorized

object
message
required
string
Example
Record not found

403

Section titled “403 ”

Forbidden

object
message
required
string
Example
Record not found

422

Section titled “422 ”

Unprocessable Entity

object
message
required
string
Example
Failed to save
errors
required
object
key
additional properties
Array<string>
Example
{
  "errors": {
    "username": [
      "Username is required.",
      "Username must be unique."
    ],
    "email": [
      "Invalid email format."
    ]
  }
}