Skip to content

Import Contacts

Tool name: import-contacts

Import validated CSV contacts; may send confirmations and start automations. THIS CHANGES REAL RECIPIENTS: contacts may be created or updated. Review validation and agree on opt-in process, warning rows and tags. listId 0 selects single opt-in without confirmation, not the account default; choose it explicitly. Obtain user approval before calling; sent messages cannot be recalled.

Input schema

importIdinteger, >= 1required

A validated import ID

listIdinteger, >= 0required

Selected opt-in process ID; 0 means single opt-in without confirmation email; choose explicitly

importWarningsbooleanrequired

Whether to import warning rows with invalid field values omitted; false excludes warning rows

assignTagIdsArray of integers

Existing manual tags to assign to imported contacts

Default:[]
warningTagIdsArray of integers

Existing manual tags assigned only to imported warning rows

Default:[]
confirmboolean

True only when the user approved importing this validated file, which can create contacts, send confirmations and start automations

Default:false
accountIdnull or integer, >= 1

User ID of the account; omit for the account of the access token

Default:null
Input example
{ "importId": 1, "listId": 0, "importWarnings": true, "assignTagIds": [], "warningTagIds": [], "confirm": false, "accountId": null }

Output schema

accountIdintegerrequired
uploadIdstring or nullrequired
importIdinteger or nullrequired
statusstringrequired
nextToolstring or nullrequired

Exact tool name to call only after beforeNextTool is satisfied; null when no tool follows automatically. Never authorizes an import.

Enum:"get-contact-import-upload-preview""prepare-contact-import""get-contact-import""import-contacts"null
beforeNextToolstringrequired

What must happen before nextTool may be called, including user confirmation of mapping or explicit import approval.

fileNamestring or nullrequired
headersArray of stringsrequired
examplesArray of itemsrequired
headerRowsinteger or nullrequired

0 for no header, 1 for column labels, 2 for a KlickTipp export with a second hash header. These rows are excluded from validation and import.

delimiterstring or nullrequired
enclosurestring or nullrequired

Quote character used for CSV text, double by default; the UI also permits single quote.

mappingOptionsobject or nullrequired
One of:
rowsinteger or nullrequired
chunksinteger or nullrequired
progressobject or nullrequired
appUrlstring or nullrequired
htmlstringrequired
Output example
{ "accountId": 0, "uploadId": "string", "importId": 0, "status": "string", "nextTool": "get-contact-import-upload-preview", "beforeNextTool": "string", "fileName": "string", "headers": [ "string" ], "examples": [ [ "string" ] ], "headerRows": 0, "delimiter": "string", "enclosure": "string", "mappingOptions": { "subscriptionFields": [ { "id": "string", "label": "string", "formats": [ "string" ] } ], "customFieldLookupTool": "string", "manualTagLookupTool": "string", "tagCreationAllowed": true, "tagNameSeparators": [ "string" ], "identifierFieldIds": [ "string" ], "ignoreByOmission": true }, "rows": 0, "chunks": 0, "progress": {}, "appUrl": "string", "html": "string" }