Pular para o conteúdo principal
POST
Comece uma exportação

Supported products

Autorizações

Authorization
string
header
obrigatório

The access token received from the authorization server in the OAuth 2.0 flow.

Corpo

application/json
associatedObjectType
string[]
obrigatório

Matriz de strings que indica tipos de objetos associados a serem incluídos na exportação.

exportInternalValuesOptions
enum<string>[]
obrigatório

Matriz de strings que especifica opções para valores internos na exportação. Valores válidos são "NAMES" e "VALUES".

Opções disponíveis:
NAMES,
VALUES
exportName
string
obrigatório

O nome atribuído à exportação, representado como uma string.

exportType
enum<string>
padrão:VIEW
obrigatório

Tipo de exportação solicitado. O único valor válido é "VIEW".

Opções disponíveis:
VIEW
format
enum<string>
obrigatório

Formato de arquivo para a exportação. Opções válidas são "XLS", "XLSX" e "CSV".

Opções disponíveis:
CSV,
XLS,
XLSX
includeLabeledAssociations
boolean
obrigatório

Booleano que indica se associações rotuladas devem ser incluídas na exportação.

includePrimaryDisplayPropertyForAssociatedObjects
boolean
obrigatório

Booleano que indica se a propriedade de exibição principal para objetos associados deve ser incluída.

language
enum<string>
obrigatório

O código de idioma para a exportação. Os valores válidos incluem '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'.

Opções disponíveis:
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
objectProperties
string[]
obrigatório

Uma matriz de strings que especifica as propriedades do objeto a serem incluídas na exportação.

objectType
string
obrigatório

String que representa o tipo de objeto exportado.

overrideAssociatedObjectsPerDefinitionPerRowLimit
boolean
obrigatório

Booleano que indica se o limite de objetos associados por definição por linha deve ser substituído.

publicCrmSearchRequest
object

Resposta

accepted

id
string
obrigatório

O ID exclusivo da exportação.

Um objeto contendo links relevantes relacionados ao processo de exportação.

Última modificação em 6 de outubro de 2026