Difference between revisions of "CRM-2 Administrative API"
From Opentaps Wiki
Jump to navigationJump to search| Line 11: | Line 11: | ||
URL extension: <tt>email-to-poll</tt> (ie, <tt>http://crm-2-url/admin/email-to-poll</tt>) | URL extension: <tt>email-to-poll</tt> (ie, <tt>http://crm-2-url/admin/email-to-poll</tt>) | ||
| − | Parameters are the ones for your mail server, ie | + | 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 PUT and DELETE, <tt>mailUser</tt> is required. |
Revision as of 18:47, 2 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 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 PUT and DELETE, mailUser is required.
