Skip to main content
POST
/
crm
/
v3
/
imports
/
Iniciar una nueva importación
curl --request POST \
  --url https://api.hubapi.com/crm/v3/imports/ \
  --header 'Content-Type: multipart/form-data' \
  --header 'private-app: <api-key>' \
  --form 'importRequest=<string>' \
  --form files=@example-file
{
  "importTemplate": {
    "templateType": "admin_defined",
    "templateId": 123
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "metadata": {
    "counters": {},
    "fileIds": [
      "<string>"
    ],
    "objectLists": [
      {
        "listId": "<string>",
        "objectType": "<string>"
      }
    ]
  },
  "importRequestJson": {},
  "importSource": "API",
  "importName": "<string>",
  "state": "STARTED",
  "id": "<string>",
  "optOutImport": true,
  "mappedObjectTypeIds": [
    "<string>"
  ],
  "updatedAt": "2023-11-07T05:31:56Z"
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing Hub -Gratuito
Sales HubSales Hub -Gratuito
Service HubService Hub -Gratuito
Content HubContent Hub -Gratuito
Esta API requiere uno de los siguientes ámbitos:
crm.import

Authorizations

private-app
string
header
required

Body

multipart/form-data
files
file
importRequest
string

Response

successful operation

createdAt
string<date-time>
required
metadata
object
required
state
enum<string>
required

El estado de la importación.

Available options:
STARTED,
PROCESSING,
DONE,
FAILED,
CANCELED,
DEFERRED,
REVERTED
id
string
required
optOutImport
boolean
required

Si la importación es o no es una lista de personas que no califican para recibir correos.

mappedObjectTypeIds
string[]
required
updatedAt
string<date-time>
required
importTemplate
object
importRequestJson
object
importSource
enum<string>
Available options:
API,
CRM_UI,
IMPORT,
MOBILE_ANDROID,
MOBILE_IOS,
SALESFORCE
importName
string