Skip to content

Begin Picked Contact CSV Upload

Tool name: create-contact-import-upload

App-only: begin transferring a selected contact CSV to its reserved uploadId. The ID comes from open-contact-import-upload. Creates no contacts.

Input schema

uploadIdstringrequired

Reserved ID returned by open-contact-import-upload

fileNamestringrequired

Name of the selected CSV file

sizeBytesintegerrequired

File size in bytes

accountIdnull or integer, >= 1

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

Default:null
Input example
{ "uploadId": "string", "fileName": "string", "sizeBytes": 0, "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" }