CRM-2 Administrative API

From Opentaps Wiki
Revision as of 07:49, 3 April 2013 by Jwickers (talk | contribs)
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/

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.