CRM-2 Administrative API - Revision history

Jwickers: /* Email Notifications */

2014-10-15T06:36:42Z

‎Email Notifications

2014-08-08T01:09:57Z

‎User Permissions

2014-08-07T12:29:00Z

‎Twitter

2014-08-06T21:28:31Z

‎Valid Activity Types

2014-05-12T22:59:23Z

‎Users

2014-04-29T22:26:50Z

‎Users

2014-01-22T23:25:19Z

‎Valid Activity Types

2014-01-22T23:25:06Z

‎Email Notifications

2014-01-22T23:24:56Z

‎Emails To Poll

2014-01-22T23:24:41Z

‎Email Notifications

@@ Line 67: / Line 67: @@
 URL extension: <tt>/admin/email-notifications</tt> (ie, <tt>https://crm2.opentaps.com/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.gmail.com</tt> for protocol and host.
+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>smtp</tt> and <tt>smtp.gmail.com</tt> for protocol and host. Note: do not try to use smtps which is not a valid transport, the code will connect using SSL on port 465 automatically.
 For all requests the clientDomain and authToken parameters are required.

← Older revision		Revision as of 01:09, 8 August 2014
Line 53:		Line 53:

	If the permission you are trying to add is not a valid permission, you will get an error message with a list of the valid permissions.		If the permission you are trying to add is not a valid permission, you will get an error message with a list of the valid permissions.
		+
		+	Valid permissions are:
		+	* CONTACT_VIEW - view contacts and contact groups
		+	* CONTACT_UPDATE - create, update, delete contacts and contact groups
		+	* ACTIVITY_VIEW - view activities, such as tasks
		+	* ACTIVITY_UPDATE - create, update, delete activities
		+	* DOMAIN_CONF - administer the domain.

	=== Email Notifications ===		=== Email Notifications ===

@@ Line 103: / Line 103: @@
 URL: <tt>https://crm2.opentaps.com/admin/twitter</tt>
-* POST adds a new user to use with twitter.  Parameters are <tt>userName</tt>, <tt>token</tt>, and <tt>tokenSecret</tt>
+* POST adds a new user to use with twitter.  Parameters are <tt>userName</tt>, <tt>userId</tt>, <tt>token</tt>, and <tt>tokenSecret</tt>
 * GET returns a list of users to use with twitter
 * DELETE removes a user.  Parameter is <tt>userName</tt>

@@ Line 91: / Line 91: @@
 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: <tt>/admin/activity-type</tt> (ie, <tt>https://crm2.opentaps.com/admin/activity-type</tt>)
+URL: <tt>https://crm2.opentaps.com/admin/activity-type</tt>
 * POST adds a single activityType
 * GET returns a list of valid activity types
 * DELETE removes a single activityType

@@ Line 41: / Line 41: @@
 * userId
 * userIdType: Same as above
 === Email Notifications ===

@@ Line 29: / Line 29: @@
 * userId: id of user.  For Gmail, use full email (someone@gmail.com).  For twitter, use username without the initial @ (someone)
 * userIdType: type of your user id.  Use GOOGLE_APPS for Gmail or TWITTER_LOGIN for Twitter.
 === Email Notifications ===

@@ Line 34: / Line 34: @@
 Configure the email account to use when sending notification emails for your domain.  You must also configure the same email as an email to poll (see below) separately so that the responses are also registered.  Otherwise, response to your notification emails will be ignored.
-URL extension: <tt>/admin/email-notifications</tt> (ie, <tt>https://crm.opentaps.com/admin/email-notifications</tt>)
+URL extension: <tt>/admin/email-notifications</tt> (ie, <tt>https://crm2.opentaps.com/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.gmail.com</tt> for protocol and host.

@@ Line 50: / Line 50: @@
 Configures the emails to be polled for your domain.
-URL extension: <tt>/admin/email-to-poll</tt> (ie, <tt>http://crm-2-url/admin/email-to-poll</tt>)
+URL extension: <tt>/admin/email-to-poll</tt> (ie, <tt>https://crm2.opentaps.com/admin/email-to-poll</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>gimap</tt> and <tt>pop.googlemail.com</tt> for protocol and host.