Skip to main content

Upload and parse a VCard file

POST 
/api/partner-gateway/v1/contacts/upload/vcard

Uploads a VCard (.vcf) file and imports its entries as contacts into your account. The file must be sent as multipart/form-data with the file in the 'file' field and the original filename (must have .vcf extension) in the 'fileName' field. VCard files can contain one or multiple contact entries. Each vCard entry is parsed and mapped to a contact record using standard vCard fields (FN, TEL, EMAIL, etc.). The import runs in CREATE_UPDATE mode: new contacts are created, and existing contacts (matched by phone number) are updated with the data from the VCard. If a listId is provided, all successfully imported contacts are automatically added to that contact list. The limit parameter controls how many parsed contacts are returned in the response preview (defaults to 10) but does not limit the actual number of contacts imported. This endpoint is particularly useful for importing contacts exported from phone address books, Outlook, Google Contacts, or other CRM tools that support the VCard standard. Returns 400 if the file does not have a .vcf extension or is not a valid VCard file. Returns 500 if an unexpected server error occurs during import processing.

Request​

Responses​

VCard file parsed successfully

Last updated on