Add Contact

curl -X POST -H "X-Api-Key: your_api_key" -d '{
  "email": "stephan@usergems.com",
  "firstName": "Stephan",
  "lastName": "Kletzl",
  "company": "UserGems",
  "relationshipType": "user"
}' "https://api.usergems.com/v1/contact"

The above command returns the following confirmation:

{
    "message": "Contact added to queue"
}

UserGems offers an API for customers to add contacts to their list of users they would like to track for job changes.

HTTP Request

GET https://api.usergems.com/v1/contact

Authentication

Please use your API Key to authenticate your request. You can request a new API Key via email to support@usergems.com. The API key must be included in a header that looks like the following:

X-Api-Key: your_api_key

Query Parameters

Parameter	Values	Mandatory	Description
email	string	X	The person’s email address
firstName	string		The first name of the person
lastName	string		The last name of the person
fullName	string		The full name of the person. If you have first and last name split, please use firstName and lastName instead.
company	string		The name of the company where the person works or worked
relationshipType	string		Type of relationship you have with this user. Allowed values: Closed Won Opp Contact, Champion, User, Open Opp Contact Closed Lost Opp Contact, Prospect, Other and any type that was created manually in the UserGems settings
custom	string		Any custom value you'd like to receive back when we provide you with a job change.

Add Account

curl -X POST -H "X-Api-Key: your_api_key" -d '{
  "reportId" : 1,
  "name" : "UserGems",
  "domain" : "usergems.com"
}' "https://api.usergems.com/v1/account"

The above command returns JSON structured like this:

{
    "message": "Account added"
}

UserGems offers an API for customers to add accounts for which they would like to receive prospects.

HTTP Request

POST https://api.usergems.com/v1/account

Authentication

Please use your API Key to authenticate your request. You can request a new API Key via email to support@usergems.com. The API key must be included in a header that looks like the following:

X-Api-Key: your_api_key

Query Parameters

Parameter	Values	Mandatory	Description
reportId	int	X	The report id where the account should be added (UserGems will provide this number).
name	string	X	Name of the account
domain	string	X	Domain of the account
salesforceId	string		The id of the account within your Salesforce.
customId	string		A unique Account id within your systems (e.g. Hubspot)
custom	string		Any custom value you'd like to receive back when we provide you with prospects for this account.

Privacy Delete

curl -X POST -H "X-Api-Key: your_api_key" -d '{
  "email" : "privacy@usergems.com"
}' "https://api.usergems.com/v1/privacy/delete"

The above command returns JSON structured like this:

{
    "message": "Contact removed"
}

UserGems offers an API for customers to remove an email address from tracking in order to comply with privacy regulations.

HTTP Request

POST https://api.usergems.com/v1/privacy/delete

Authentication

Please use your API Key to authenticate your request. You can request a new API Key via email to support@usergems.com. The API key must be included in a header that looks like the following:

X-Api-Key: your_api_key

Query Parameters

Parameter	Values	Mandatory	Description
email	int	X	The email address you would like to remove from tracking.

Errors

The UserGems API uses the following error codes:

Error Code	Meaning
400	Bad Request
401	Unauthorized
403	Forbidden – You are not allowed to access this resource
404	Not Found
405	Method Not Allowed
406	Not Acceptable – You requested a format that isn’t json
410	Gone
429	Too Many Requests
500	Internal Server Error – We had a problem with our server. Try again later.
503	Service Unavailable – We’re temporarially offline for maintanance. Please try again later.