CRM-2 Administrative API

From Opentaps Wiki
Revision as of 21:55, 28 March 2013 by Sichen (talk | contribs) (Protected "CRM-2 Administrative API": Sysop page [edit=sysop:move=sysop])
Jump to navigationJump to search

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/

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

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
Retrieved from "https://docs.opentaps.org/docs/index.php?title=CRM-2_Administrative_API&oldid=7341"