Difference between revisions of "CRM-2 Administrative API"
From Opentaps Wiki
Jump to navigationJump to searchm (Protected "CRM-2 Administrative API": Sysop page [edit=sysop:move=sysop]) |
|||
| Line 1: | Line 1: | ||
Administrative API is used to manage your domain. The API calls follow the general RESTful pattern of [[CRM-2 API]]. The base URL is <tt>http://crm-2-url/admin/</tt> | Administrative API is used to manage your domain. 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 '''DOMAIN_CONF''' permission. | ||
Here are the additional resources available: | Here are the additional resources available: | ||
Revision as of 21:57, 28 March 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:
Contents
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
POST
Add new email to poll with parameters:
- mailUser
- mailPass
- mailStoreProtocol
- mailHost
For gmail, use imaps and pop.google.com for protocol and host.
PUT
Updates an email to poll:
- mailUser - identifies the email to update
Other parameters are same as for POST operation and will be updated for your email.
DELETE
Removes an email from polling list:
- mailUser - email to be removed
