Zum Hauptinhalt springen
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 'importRequest=<string>' \
  --form files=@example-file
{
  "importTemplate": {
    "templateType": "admin_defined",
    "templateId": 123
  },
  "createdAt": "2020-01-14T22:45:00.153+00:00",
  "metadata": {
    "counters": "{\"TOTAL_ROWS\":2,\"CREATED_OBJECTS\":1,\"UPDATED_OBJECTS\":1,\"UNIQUE_OBJECTS_WRITTEN\":2,\"PROPERTY_VALUES_EMITTED\":2}",
    "fileIds": "[\"3579849\"]",
    "objectLists": "[{\"listId\":\"3\",\"objectType\":\"contacts\"}]"
  },
  "importRequestJson": {},
  "importSource": "API",
  "importName": "<string>",
  "state": "DONE",
  "id": "1471",
  "optOutImport": false,
  "mappedObjectTypeIds": [
    "<string>"
  ],
  "updatedAt": "2020-01-14T22:45:00.153+00:00"
}
Produtos suportados
Requer um dos seguintes produtos ou superior.
Marketing HubMarketing HubGrátis
Sales HubSales HubGrátis
Service HubService HubGrátis
Content HubContent HubGrátis

​
Escopos Necessários

Esta API requer um dos seguintes escopos:
  • crm.import

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
Example:

"2020-01-14T22:45:00.153+00:00"

​
metadata
object
required
​
state
enum<string>
required

O status da importação.

Available options:
STARTED,
PROCESSING,
DONE,
FAILED,
CANCELED,
DEFERRED,
REVERTED
Example:

"DONE"

​
id
string
required
Example:

"1471"

​
optOutImport
boolean
required

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

Example:

false

​
mappedObjectTypeIds
string[]
required
​
updatedAt
string<date-time>
required
Example:

"2020-01-14T22:45:00.153+00:00"

​
importTemplate
object
​
importRequestJson
object
​
importSource
enum<string>
Available options:
API,
CRM_UI,
IMPORT,
MOBILE_ANDROID,
MOBILE_IOS,
SALESFORCE
​
importName
string
⌘I