Zimbra REST API Reference:Import Contacts: Difference between revisions
Malte Stretz (talk | contribs) (Remove old ZCS_6.0 prefixes) |
|||
(12 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
[[ZCS_6.0:Zimbra_REST_API_Reference|<< Back to Zimbra REST API Reference]] | {{Template:TabHeader}} | ||
{{Template:Tab2|[[Zimbra_REST_API_Reference|Introduction]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Folder|Method: Get Folder]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Import_Message|Method: Import Message]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Contacts|Method: Get Contacts]]}} | |||
{{Template:Tab1|[[Zimbra_REST_API_Reference:Import_Contacts|Method: Import Contacts]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Calendar|Method: Get Calendar]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_FreeBusy|Method: Get FreeBusy]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Import_Appointments|Method: Import Appointments]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Tasks|Method: Get Tasks]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Item|Method: Get Item]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Briefcase|Method: Get Briefcase]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Get_Briefcase_Item|Method: Get Briefcase Item]]}} | |||
{{Template:Tab2|[[Zimbra_REST_API_Reference:Export_Mailbox|Method: Export Mailbox]]}} | |||
{{Template:TabFooter}} | |||
{{Article Infobox|{{devel}}|{{ZCS 8.0}}|{{ZCS 7.0}}|{{ZCS 6.0}}|}}[[ZCS_6.0:Zimbra_REST_API_Reference|<< Back to Zimbra REST API Reference]] | |||
== REST API Method: Import Contacts == | == REST API Method: Import Contacts == | ||
Import contacts. The default folder is "contacts" but user-defined folders are also supported. | |||
=== URL === | === URL === | ||
Line 10: | Line 26: | ||
http://localhost:7070/home/john.doe/contacts?{params} | http://localhost:7070/home/john.doe/contacts?{params} | ||
</pre> | </pre> | ||
Go to [[ZCS_6.0:Zimbra_REST_API_Reference#Command_Format|Command Format]] | |||
=== HTTP Method === | === HTTP Method === | ||
Line 17: | Line 35: | ||
=== Formats === | === Formats === | ||
<code>csv</code> ([[ZCS_6.0:Zimbra_REST_API_Reference#Response_Formats|Go to Response Formats]]) | <code>csv,vcf</code> ([[ZCS_6.0:Zimbra_REST_API_Reference#Response_Formats|Go to Response Formats]]) | ||
=== Requires Authentication === | === Requires Authentication === | ||
Line 26: | Line 44: | ||
<ul> | <ul> | ||
<li><code>fmt</code>. | <li><code>fmt</code>. Required. The import format. Defaults to <code>csv</code>.</li> | ||
</ul> | </ul> | ||
=== Usage Examples === | === Usage Examples === | ||
The following examples show using the [http://en.wikipedia.org/wiki/CURL curl] utility to post a file to the REST command. Be sure to replace {username} and {password} with the account username and password. | |||
Import contacts from CSV format: | |||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/contacts | curl -{username}:{password} --upload-file /tmp/mycontacts.csv http://localhost:7070/home/john.doe/contacts?fmt=csv | ||
</pre> | </pre> | ||
Import contacts from VCF format: | |||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/contacts?fmt= | curl -{username}:{password} --upload-file /tmp/mycontact.vcf http://localhost:7070/home/john.doe/contacts?fmt=vcf | ||
</pre> | </pre> | ||
Import contacts from CSV format into the user-defined folder "Contacts > MyBusinessContacts: | |||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/contacts?fmt= | curl -{username}:{password} --upload-file /tmp/mycontacts.csv http://localhost:7070/home/john.doe/contacts/mybusinesscontacts?fmt=csv | ||
</pre> | </pre> | ||
Import contacts from CSV format into the user-defined folder "SalesContacts: | |||
<pre> | <pre> | ||
http://localhost:7070/home/john.doe/ | curl -{username}:{password} --upload-file /tmp/mycontacts.csv http://localhost:7070/home/john.doe/salescontacts?fmt=csv | ||
</pre> | </pre> | ||
{{Article Footer|Zimbra Collaboration Server 7.0|01/16/2010}} | |||
[[Category:REST]] | |||
[[Category:ZCS 7.0]] | |||
[[Category:ZCS 6.0]] | |||
[[Category:Developers]] |
Latest revision as of 17:24, 5 August 2014
Article Information |
---|
This article applies to the following ZCS versions. |
<< Back to Zimbra REST API Reference
REST API Method: Import Contacts
Import contacts. The default folder is "contacts" but user-defined folders are also supported.
URL
http://localhost:7070/home/john.doe/contacts?{params}
Go to Command Format
HTTP Method
POST
Formats
csv,vcf
(Go to Response Formats)
Requires Authentication
true
(Go to Authentication)
Parameters
fmt
. Required. The import format. Defaults tocsv
.
Usage Examples
The following examples show using the curl utility to post a file to the REST command. Be sure to replace {username} and {password} with the account username and password.
Import contacts from CSV format:
curl -{username}:{password} --upload-file /tmp/mycontacts.csv http://localhost:7070/home/john.doe/contacts?fmt=csv
Import contacts from VCF format:
curl -{username}:{password} --upload-file /tmp/mycontact.vcf http://localhost:7070/home/john.doe/contacts?fmt=vcf
Import contacts from CSV format into the user-defined folder "Contacts > MyBusinessContacts:
curl -{username}:{password} --upload-file /tmp/mycontacts.csv http://localhost:7070/home/john.doe/contacts/mybusinesscontacts?fmt=csv
Import contacts from CSV format into the user-defined folder "SalesContacts:
curl -{username}:{password} --upload-file /tmp/mycontacts.csv http://localhost:7070/home/john.doe/salescontacts?fmt=csv