Skip to main content
POST
Import contacts from CSV

Authorizations

Authorization
string
header
required

API key authentication. Use your API key as the bearer token.

Body

application/json
file_content
string
required

Base64 encoded CSV content

Example:

"ZW1haWwsZmlyc3RfbmFtZSxsYXN0X25hbWUKam9obkBleGFtcGxlLmNvbSxKb2huLERvZQ=="

column_mappings
object[]
required

Mappings from CSV columns to contact properties

Example:
handle_missing
enum<string>
default:create

How to handle emails not found in contacts: 'create' to add new contacts, 'skip' to ignore them

Available options:
create,
skip
Example:

"create"

segment_id
string<uuid>

Optional segment ID to add imported contacts to

Example:

"123e4567-e89b-12d3-a456-426614174000"

Response

Import completed successfully

created
integer
required

Number of new contacts created

Example:

45

updated
integer
required

Number of existing contacts updated

Example:

10

skipped
integer
required

Number of rows skipped (invalid data or handle_missing='skip')

Example:

3

errors
object[]
required

List of errors encountered during import

Example: