Contents

Reset (Permanent) Token

Method: POST
URL extension: /admin/reset-token
Parameter:

Current permanent auth token for your user

Client domain

This API expires (deletes) the current permanent auth token, generates a new one, and returns it to you as the result. After this, you must use the new one to access the system. The API will validate that the token you've supplied is for a user of your domain.

Users

Add or remove users for a Contact

URL extension: /admin/user

Parameters:

contactId : unique ID of your Contact

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.

Add a new User and Contact at the same time with

URL extension: /admin/user-contact

Parameters:

firstName

lastName

companyName

emailAddress

userId

userIdType: Same as above

User Permissions

Add or remove a security permission from a user

URL extension: /admin/user-permission

Parameters:

userId: unique id of the user

permission: Permission string

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.

Email Notifications

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.

Parameters are the ones for your mail server, ie mailUser, mailPass, mailStoreProtocol, mailHost. For gmail, use smtp and smtp.gmail.com 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.

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.

Twitter

Configures the twitter users which opentaps CRM2 uses to interact with twitter. Normally this is done automatically when somebody logs into twitter.com once from the login page, but you can control it more explicitly using this API to add a user or remove one that you don't want to use.