phone_book

Returns import tasks

get/v1/phone_book/contacts/import/tasks

Query parameters

pageinteger

Request a specific page

sizeinteger

Sets size of a page

Response

importFileIdinteger

import file id

fieldMappingobject

fields to import file column mapping

contactGroupIdsinteger[]

contact groups to assign

charsetstring

override detected charset

delimiterstring

override detected delimiter

skipFirstRowboolean

skip first row

continueOnErrorboolean

continue on error

ignoreExistingContactsboolean

don't touch existing contacts

ignoreEmptyContactsboolean

don't import empty contacts (containing no recipients)

mergeContactGroupIdsboolean

whether to merge or delete existing group membership

dryRunboolean

dry run

duplicateCheckFieldstring

whether to check for mobile or whatsapp duplicates

diallingCodeIdinteger

idinteger required

processedinteger

total of processed contacts

addedinteger

newly added contacts

updatedinteger

updated contacts

updatedCsvinteger

updated csv contacts

ignoredinteger

ignored contacts

failedinteger

failed contacts

blacklistedinteger

blacklisted recipients

recipientsPerCountriesobject

map of recipients per countries

emptyinteger

empty contacts

nonEnabledWhatsappinteger

non enabled whatsapp recipients

resultedContactIdsinteger[]

set of tracked contacts

Changes

No recorded changes to this endpoint across all 1 revision of this API.