Difference between revisions of "CRM-2 Administrative API"
From Opentaps Wiki
Jump to navigationJump to searchm |
|||
| Line 1: | Line 1: | ||
| − | Administrative API is used to manage your domain. | + | Administrative API is used to manage your domain. |
| − | To access the admin API, your user must '''DOMAIN_CONF''' permission. | + | The API calls follow the general RESTful pattern of [[CRM-2 API]]. The base URL is <tt>http://crm-2-url/admin/</tt> |
| + | |||
| + | To access the admin API, your user must have the '''DOMAIN_CONF''' permission. | ||
Here are the additional resources available: | Here are the additional resources available: | ||
Revision as of 07:49, 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 PUT and DELETE, mailUser is required.
