Import a vCard file into a mailbox's personal contacts
The address book a person exported from their previous webmail (Roundcube, cPanel, Outlook, Apple, Google: vCard 2.1, 3.0 or 4.0), into this mailbox's PERSONAL address book, never the customer's shared directory. Add-only: a card whose address (any of them) is already in the book is skipped as exists; nothing is changed or removed. A card's CATEGORIES (comma-separated) become the contact's personal groups: groups that do not exist yet are created, up to 200 per mailbox; a skipped card changes no group. Send the file as the body (text/vcard, text/x-vcard or text/plain) or as JSON { "vcf": "..." }; ?dryRun=1 answers the same report without writing. At most 2 MB of text (413) and 5000 cards per call (truncated: true past that), 10 000 personal contacts per mailbox (422 PERSONAL_CONTACTS_CAP, before anything is written), 120 calls per 10 minutes per partner. Available together with migrations (403 MIGRATION_NOT_AVAILABLE until then); an inactive mailbox answers 409. Requires partner:write.
Request
- Base URL: https://faivelo.com/api/partner
- URL: https://faivelo.com/api/partner/customers/{id}/domains/{domain}/mailboxes/{address}/contacts/import
- Auth: HTTP bearer
Path parameters
The customer id returned when the customer was created
The customer's domain name, e.g. smiledental.example
Full mailbox address, URL-encoded, e.g. hello%40smiledental.example
Query parameters
Report what would happen without writing
Request body
Response
What was imported and what was skipped
Example response
{
"success": true
}Changes
No recorded changes to this operation across all 1 revision of this API.