Skip to main content
POST
Create contact import

Authorizations

Authorization
string
header
required

Behalf of an Operator (default). A JWT issued by Talqui Core when an operator signs in, scoped to every tenant that operator belongs to. Send as Authorization: Bearer <jwt-token>.

Path Parameters

tenantID
string<uuid>
required

The tenant the contacts are imported into.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
fileID
string
required

fileID of the CSV the browser uploaded to talqui-services-storage (namespace "contact-imports", private, this tenant).

Required string length: 1 - 128
fileMapping
object
required

CSV header → contact field. Targets: contactFullName, contactFirstname, contactLastname, contactPhone, contactEmail, or contactMeta..

fileName
string
required

Original file name, shown back to the operator.

Required string length: 1 - 255
contactTags
string[]

Tags applied to every imported contact, on top of the generated import tag.

Maximum array length: 20
Required string length: 1 - 64
country
string
default:BR

ISO country used to normalise phones typed without an international prefix.

Required string length: 2
delimiter
string
default:;

Column separator of the uploaded file: any single character except ", CR, LF and NUL.

Required string length: 1
encoding
enum<string>

Text encoding of the uploaded file. Detected from its bytes when absent; a byte-order mark or a UTF-16 NUL pattern overrides a conflicting value.

Available options:
utf-8,
utf-16le,
utf-16be,
windows-1252,
macintosh,
ibm850
recordDelimiter
enum<string>
default:auto

Line ending of the uploaded file. auto lets the parser detect it.

Available options:
auto,
lf,
crlf,
cr

Response

Response for status 200.

importID
string
required

Identifier of the created import job; poll it for progress.

importStatus
string
required

Lifecycle status. Always "pending" on creation.

importTag
string
required

Tag stamped on every contact this import creates or updates, so they can be found again later.