Pular para o conteúdo principal
POST
/
crm
/
v3
/
imports
Iniciar uma nova importação
curl --request POST \
  --url https://api.hubapi.com/crm/v3/imports/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form files='@example-file' \
  --form 'importRequest=<string>'
{
  "createdAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "mappedObjectTypeIds": [
    "<string>"
  ],
  "metadata": {
    "counters": {},
    "fileIds": [
      "<string>"
    ],
    "objectLists": [
      {
        "listId": "<string>",
        "objectType": "<string>"
      }
    ]
  },
  "optOutImport": true,
  "state": "CANCELED",
  "updatedAt": "2023-11-07T05:31:56Z",
  "importName": "<string>",
  "importRequestJson": {},
  "importSource": "API",
  "importTemplate": {
    "templateId": 123,
    "templateType": "admin_defined"
  }
}

Produtos suportados

Requer um dos seguintes produtos ou superior.
Marketing HubMarketing Hub -Grátis
Sales HubSales Hub -Grátis
Service HubService Hub -Grátis
Content HubContent Hub -Grátis

Authorizations

Authorization
string
header
required

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

Body

multipart/form-data
files
file
importRequest
string

Response

successful operation

createdAt
string<date-time>
required

A data e hora em que o objeto foi criado, no formato ISO 8601.

id
string
required

O identificador exclusivo desta importação.

mappedObjectTypeIds
string[]
required
metadata
object
required
optOutImport
boolean
required

Se a importação é uma lista de pessoas desqualificadas para receber e-mails.

state
enum<string>
required

O status da importação.

Opções disponíveis:
CANCELED,
DEFERRED,
DONE,
FAILED,
PROCESSING,
REVERTED,
STARTED
updatedAt
string<date-time>
required

A data e hora da última atualização do documento de importação, formatado como um instante ISO 8601.

importName
string

Nome fornecido pelo usuário para esta importação.

importRequestJson
object

A configuração completa da solicitação de importação como um objeto JSON.

importSource
enum<string>

Indica onde/como a importação foi iniciada.

Opções disponíveis:
API,
CRM_UI,
IMPORT,
MOBILE_ANDROID,
MOBILE_IOS,
SALESFORCE
importTemplate
object
Last modified on December 8, 2025