Start an export
Begins exporting CRM data for the portal as specified in the request body
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
- Option 1
- Option 2
An array of strings indicating the types of associated objects to include in the export.
An array of strings specifying options for internal values in the export. Valid values are 'NAMES' and 'VALUES'.
NAMES, VALUES The name assigned to the export, represented as a string.
The type of export being requested. The only valid value is 'VIEW'.
VIEW The file format for the export. Valid options are 'XLS', 'XLSX', and 'CSV'.
CSV, XLS, XLSX A boolean indicating whether labeled associations should be included in the export.
A boolean indicating whether the primary display property for associated objects should be included.
The language code for the export. Valid values include 'EN', 'FR', 'DE', 'JA', 'ES', 'PT_BR', 'NL', 'BN', 'CS', 'DA_DK', 'EL_GR', 'ES_MX', 'FI', 'HR', 'HU', 'ID', 'IT', 'KO_KR', 'NO', 'PL', 'RO', 'RU', 'SV', 'TH', 'VI_VN', 'ZH_CN', 'ZH_HK', 'AF_ZA', 'AR_EG', 'BG', 'CA_ES', 'SL', 'TR', 'UK', 'EN_GB', 'FR_CA', 'HE_IL', 'LT_LT', 'PT_PT', 'SK_SK', 'MS', 'TL', 'ZH_TW', 'HI_IN', 'ET_EE'.
AF_ZA, AR_EG, BG, BN, CA_ES, CS, DA_DK, DE, EL_GR, EN, EN_GB, ES, ES_MX, ET_EE, FI, FR, FR_CA, HE_IL, HI_IN, HR, HU, ID, IT, JA, KO_KR, LT_LT, MS, NL, NO, PL, PT_BR, PT_PT, RO, RU, SK_SK, SL, SV, TH, TL, TR, UK, VI_VN, ZH_CN, ZH_HK, ZH_TW An array of strings specifying the properties of the object to be included in the export.
A string representing the type of object being exported.
A boolean indicating whether to override the limit of associated objects per definition per row.