Difference between revisions of "CRM-2 Administrative API"
(→Valid Activity Types) |
|||
| Line 6: | Line 6: | ||
Here are the additional resources available: | Here are the additional resources available: | ||
| + | |||
| + | === Email Notifications === | ||
| + | |||
| + | Configure the email account to use when sending notification emails for your domain. | ||
| + | |||
| + | URL extension: <tt>/admin/email-notifications</tt> (ie, <tt>http://crm-2-url/admin/email-notifications</tt>) | ||
| + | |||
| + | Parameters are the ones for your mail server, ie <tt>mailUser</tt>, <tt>mailPass</tt>, <tt>mailStoreProtocol</tt>, <tt>mailHost</tt>. For gmail, use <tt>smtps</tt> and <tt>smtp.google.com</tt> for protocol and host. | ||
| + | |||
| + | For all requests the clientDomain and authToken parameters are required. | ||
| + | |||
| + | * The method POST and PUT is used to SET the email notification account settings. | ||
| + | * The method DELETE is used to REMOVE the email notification account settings. | ||
| + | * The method GET is used to GET the current email notification account settings. | ||
| + | |||
| + | Note: the password is encrypted in the DB and won't be returned in the replies. | ||
=== Emails To Poll === | === Emails To Poll === | ||
| Line 23: | Line 39: | ||
For POST, PUT and DELETE, mailUser is required. | For POST, PUT and DELETE, mailUser is required. | ||
| + | |||
| + | Note: the password is encrypted in the DB and won't be returned in the replies. | ||
=== Valid Activity Types === | === Valid Activity Types === | ||
Revision as of 06:57, 2 July 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:
Email Notifications
Configure the email account to use when sending notification emails for your domain.
URL extension: /admin/email-notifications (ie, http://crm-2-url/admin/email-notifications)
Parameters are the ones for your mail server, ie mailUser, mailPass, mailStoreProtocol, mailHost. For gmail, use smtps and smtp.google.com for protocol and host.
For all requests the clientDomain and authToken parameters are required.
- The method POST and PUT is used to SET the email notification account settings.
- The method DELETE is used to REMOVE the email notification account settings.
- The method GET is used to GET the current email notification account settings.
Note: the password is encrypted in the DB and won't be returned in the replies.
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.
Note: the password is encrypted in the DB and won't be returned in the replies.
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
