Skip to main content
POST
Import people

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Body

application/json
rows
object[]
required
Required array length: 1 - 2000 elements
dry_run
boolean
default:false

Check and preview only; nothing is written.

Response

What the import did, or would do on a dry run.

dry_run
boolean
required
total_rows
integer
required
would_create
integer
required

How many people the rows make.

created
integer
required

How many people were made: 0 on a dry run or when there are errors.

skipped
object[]
required

Rows whose email is already on a person.

errors
object[]
required

What is wrong, by line. Any error means nothing is written.

preview
object[]
required

The first 10 people the rows make.

import_id
string
fetches
object

How many links are to be fetched.