Difference between revisions of "CRM-2 Administrative API"
m |
(→Emails To Poll) |
||
| Line 15: | Line 15: | ||
Parameters are the ones for your mail server, ie <tt>mailUser</tt>, <tt>mailPass</tt>, <tt>mailStoreProtocol</tt>, <tt>mailHost</tt>. For gmail, use <tt>imaps</tt> and <tt>pop.google.com</tt> for protocol and host. | Parameters are the ones for your mail server, ie <tt>mailUser</tt>, <tt>mailPass</tt>, <tt>mailStoreProtocol</tt>, <tt>mailHost</tt>. For gmail, use <tt>imaps</tt> and <tt>pop.google.com</tt> for protocol and host. | ||
| − | For PUT and DELETE, | + | For all requests the clientDomain and authToken parameters are required. |
| + | |||
| + | The method POST is used to ADD email to poll. | ||
| + | The method PUT is used to UPDATE email to poll. | ||
| + | The method DELETE is used to REMOVE email to poll. | ||
| + | The method GET is used to GET list of the emails to poll. | ||
| + | |||
| + | For POST, PUT and DELETE, mailUser is required. | ||
Revision as of 11:09, 3 April 2013
Administrative API is used to manage your domain.
The API calls follow the general RESTful pattern of CRM-2 API. The base URL is http://crm-2-url/admin/
To access the admin API, your user must have the DOMAIN_CONF permission.
Here are the additional resources available:
Emails To Poll
Configures the emails to be polled for your domain.
URL extension: email-to-poll (ie, http://crm-2-url/admin/email-to-poll)
Parameters are the ones for your mail server, ie mailUser, mailPass, mailStoreProtocol, mailHost. For gmail, use imaps and pop.google.com for protocol and host.
For all requests the clientDomain and authToken parameters are required.
The method POST is used to ADD email to poll. The method PUT is used to UPDATE email to poll. The method DELETE is used to REMOVE email to poll. The method GET is used to GET list of the emails to poll.
For POST, PUT and DELETE, mailUser is required.
