Bulk import records (create or update), optionally into a list

Authorization

x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

entityType?string

Value in"lo" | "agent" | "company" | "branch"

listId?string

objectType*CrmObjectType

Value in"people" | "companies"

ownerUserId?string

Default working owner (member userId) for created rows; a row's own ownerUserId overrides it. Both fall back to the caller. Assigning an owner other than the caller requires an org admin.

rows*array<>

Response Body

`application/json`

curl -X POST "https://example.com/v1/crm/import" \  -H "Content-Type: application/json" \  -d '{    "objectType": "people",    "rows": [      {}    ]  }'

{
  "data": {
    "created": 0,
    "enrichJobId": "string",
    "failed": 0,
    "results": [
      {
        "code": "MISSING_NAME",
        "entityId": "string",
        "error": "string",
        "outcome": "created",
        "row": 0
      }
    ],
    "total": 0,
    "updated": 0
  }
}

{
  "data": {
    "jobId": "string"
  }
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string",
  "limit": 0,
  "size": 0
}

{
  "error": "string"
}

Bulk import records (create or update), optionally into a list

Authorization

Request Body

Response Body

200application/json

202application/json

400application/json

401application/json

403application/json

404application/json

413application/json

502application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`