CRM-2 Administrative API

From Opentaps Wiki
Revision as of 00:09, 17 April 2013 by Sichen (talk | contribs) (→‎Valid Activity Types)
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: /admin/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 all requests the clientDomain and authToken parameters are required.

  • The method POST is used to ADD email to poll.
  • The method PUT is used to UPDATE email to poll.
  • The method DELETE is used to REMOVE email to poll.
  • The method GET is used to GET list of the emails to poll.

For POST, PUT and DELETE, mailUser is required.

Valid Activity Types

Configures the valid activity types for your domain's application settings. Activity types are always capitalized and automatically capitalized when you add them.

URL extension: /admin/activity-type (ie, http://crm-2-url/admin/activity-type)

  • POST adds a single activityType
  • GET returns a list of valid activity types
  • DELETE removes a single activityType
Retrieved from "https://docs.opentaps.org/docs/index.php?title=CRM-2_Administrative_API&oldid=7358"