Pular para o conteúdo

POST /v1/contacts/import

POST
/v1/contacts/import
curl --request POST \
--url https://seu-endereco-da-api/v1/contacts/import \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form file=@file \
--form tagId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Permissão que a Chave de acesso precisa: Importar contatos (contacts:import).

Media typemultipart/form-data
object
file
required

CSV with columns name, phoneNumber, optional attributes (JSON) and one optional column per custom field, headed by its label or key

string format: binary
tagId

Tag applied to every contact the spreadsheet names, new or already in the base

string format: uuid
Media typeapplication/json
object
id
required
string
status
required
string
Allowed values: pending processing completed failed
totalRows
required
number
processedRows
required
number
createdCount
required
number
completedCount
required

Contacts that already existed and had empty fields filled by the spreadsheet

number
skippedCount
required

Rows whose contact was already in the base

number
limitSkippedCount
required

Rows that were not saved because the plan’s contact limit was reached

number
taggedCount
required

Contacts that got the requested tag: the audience a campaign built from this spreadsheet reaches

number
errorCount
required
number
partialCount
required

Contacts that entered without one or more refused field values

number
rowIssueCount
required

Every refused value, refused row and ignored column, listed or not

number
rowIssues
required

The first 1000 issues: spreadsheet row (1 is the header), column and reason

Array<object>
object
row
required
number
column
required
string
reason
required
string
error
required
string
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time

Example

{
"status": "pending"
}

File is required or exceeds the size limit