Preview CRM CSV import

POST/v1/crm/imports

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Request body

requiredapplication/json

contentstring

Alias for csv

csvstring

CSV text with a header row

object_kindstringrequired

rowsobject[] | null

Responses

200OK

committed_atstring

committed_countinteger<int64>required

created_atstringrequired

idstringrequired

object_kindstringrequired

partial_behaviorstringrequired

previewCRMImportPreviewrequired

Show properties

headersstring[] | nullrequired

invalid_rowsinteger<int64>required

partial_behaviorstringrequired

row_errorsCRMImportRowError[] | nullrequired

Show properties

Array of CRMImportRowError

fieldstring

messagestringrequired

row_numberinteger<int64>required

rowsobject[] | nullrequired

total_rowsinteger<int64>required

valid_rowsinteger<int64>required

row_errorsCRMImportRowError[] | nullrequired

Show properties

Array of CRMImportRowError

fieldstring

messagestringrequired

row_numberinteger<int64>required

skipped_countinteger<int64>required

source_formatstringrequired

statusstringrequired

updated_atstringrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X POST "/v1/crm/imports" \
  -H "Content-Type: application/json" \
  -d '{
  "content": "string",
  "csv": "string",
  "object_kind": "string",
  "rows": [
    {}
  ]
}'

const response = await fetch("/v1/crm/imports", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "content": "string",
  "csv": "string",
  "object_kind": "string",
  "rows": [
    {}
  ]
})
});

import requests

response = requests.post(
    "/v1/crm/imports",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "content": "string",
  "csv": "string",
  "object_kind": "string",
  "rows": [
    {}
  ]
},
)

Response

{
  "committed_at": "string",
  "committed_count": 0,
  "created_at": "string",
  "id": "string",
  "object_kind": "string",
  "partial_behavior": "string",
  "preview": {
    "headers": [
      "string"
    ],
    "invalid_rows": 0,
    "partial_behavior": "string",
    "row_errors": [
      {
        "field": "string",
        "message": "string",
        "row_number": 0
      }
    ],
    "rows": [
      {}
    ],
    "total_rows": 0,
    "valid_rows": 0
  },
  "row_errors": [
    {
      "field": "string",
      "message": "string",
      "row_number": 0
    }
  ],
  "skipped_count": 0,
  "source_format": "string",
  "status": "string",
  "updated_at": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}