Passer au contenu principal
POST
/
crm
/
v3
/
imports
Commencer une nouvelle importation
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"
  }
}

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing Hub -Gratuit
Sales HubSales Hub -Gratuit
Service HubService Hub -Gratuit
Content HubContent Hub -Gratuit

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

L'horodatage du moment où l'objet a été créé, au format ISO 8601.

id
string
required

L'identifiant unique pour cet import.

mappedObjectTypeIds
string[]
required
metadata
object
required
optOutImport
boolean
required

Si l'importation est une liste de personnes qui ne doivent plus recevoir des e-mails ou non.

state
enum<string>
required

Le statut de l'importation.

Options disponibles:
CANCELED,
DEFERRED,
DONE,
FAILED,
PROCESSING,
REVERTED,
STARTED
updatedAt
string<date-time>
required

L'horodatage de la dernière mise à jour de la fiche d'informations de l'import, au format ISO 8601 instantané.

importName
string

Le nom fourni par l'utilisateur pour cet import.

importRequestJson
object

La configuration complète de la demande d'import sous forme d'objet JSON.

importSource
enum<string>

Indique où/comment l'import a été lancé.

Options disponibles:
API,
CRM_UI,
IMPORT,
MOBILE_ANDROID,
MOBILE_IOS,
SALESFORCE
importTemplate
object