Active with remarks |
---|
This application needs additional settings. Please follow the documentation below to create your own connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…). More. |
The Salesmate modulesThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) More allow you to watch, create, update, list, retrieve, and delete the deals, activities, contacts, and companies in your Salesmate account.
Prerequisites
-
A Salesmate account
In order to use Salesmate with Boost.spaceCentralization and synchronization platform, where you can organize and manage your data. More IntegratorPart of the Boost.space system, where you can create your connections and automate your processes. More, it is necessary to have a Salesmate account. If you do not have one, you can create a Salesmate account at accounts.salesmate.io/registration.
Note | |
---|---|
The moduleThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) More dialog fields that are displayed in bold (in the Boost.space Integrator scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive. More, not in this documentation article) are mandatory! |
To connect your Salesmate account to Boost.space Integrator you need to obtain the Access Key, App Private Key, and Session Key details from your Salesmate account and insert it in the Create a connection dialog in the Boost.space Integrator module.
1. Login to your Salesmate account.
2. Click the Profile Icon > My Account > Access Key.
3. Here you can find the Access Key, App Private Key, and Session Key details.
4. Go to Boost.space Integrator and open the Salesmate module’s Create a connection dialog.
5. In the Connection name field, enter a name for the connection.
6. In the Access Key, App Private Key, and Session Key field, enter the details provided in step 3 respectively.
7. In the Linkname field, enter your Salesmate account’s URL address. For example, www.xyz.salesmate.io
.
TriggersEvery scenario has a trigger, an event that starts your scenario. A scenario must have a trigger. There can only be one trigger for each scenario. When you create a new scenario, the first module you choose is your trigger for that scenario. Create a trigger by clicking on the empty module of a newly created scenario or moving the... when a new deal is created.
Connection |
|
Limit |
Set the maximum number of deals Boost.space Integrator should return during one scenario execution cycleA cycle is the operation and commit/rollback phases of scenario execution. A scenario may have one or more cycles (one is the default).. |
List all deals.
Connection |
|
Limit |
Set the maximum number of deals Boost.space Integrator should return during one scenario execution cycle. |
Sort By |
Enter the option to sort the deals. For example, |
Sort Order |
Enter the order in which you want to list the deals. For example, |
Custom View ID |
Enter the Custom View ID of the deal you want to list. |
Finds a deal.
Connection |
|
Deal ID |
Select the Deal ID whose details you want to retrieve. |
Creates a deal.
Connection |
|
Title |
Enter a name for the deal. |
Primary Contact |
Select the primary contact for the deal. |
OwnerCan manage members, managers and owners of a specific space. Can view and manage items. Can edit settings of a given space. More ID |
Select the Owner ID of the contact. |
Pipeline |
Select the applicable pipeline of the deal. For example, |
StatusCreate statuses for each module separately to create an ideal environment for efficient and consistent work. More |
Select the status of the deal:
|
Stage |
Select the deal stage:
|
Currency |
Enter a three-character currency code. For example, |
Priority |
Select the priority of the deal:
|
Source |
Select the source from where you received the deal:
|
Primary Company |
Select the primary company associated with the deal. |
Estimated Close Date |
Enter the date by when the deal is expected to close. |
Deal Value |
Enter the amount expected from the deal. |
Description |
Enter the details of the deal. |
Tags |
Enter a comma-separated list of tags. |
Followers |
Add the followers for the deal: Contact or UserCan use the system on a limited basis based on the rights assigned by the admin. More Select the option for the follower. Contact Select the contact that you want to add as a contact for the deal. User Select the contact that you want to add as a contact for the deal. |
Updates an existing deal.
Connection |
|
Deal ID |
Select the Deal ID whose details you want to update. |
Title |
Enter a name for the deal. |
Primary Contact |
Select the primary contact for the deal. |
Owner ID |
Select the Owner ID of the contact. |
Pipeline |
Select the applicable pipeline of the deal. For example, |
Status |
Select the status of the deal:
|
Stage |
Select the deal stage:
|
Currency |
Enter a three-character currency code. For example, |
Priority |
Select the priority of the deal:
|
Source |
Select the source from where you received the deal:
|
Primary Company |
Select the primary company associated with the deal. |
Estimated Close Date |
Enter the date by when the deal is expected to close. |
Deal Value |
Enter the amount expected from the deal. |
Description |
Enter the details of the deal. |
Tags |
Enter a comma-separated list of tags. |
Followers |
Add the followers for the deal: Contact or User Select the option for the follower. Contact Select the contact that you want to add as a contact for the deal. User Select the contact that you want to add as a contact for the deal. |
Deletes an existing deal.
Connection |
|
Deal ID |
Select the Deal ID you want to delete. |
Triggers when a new activity is created.
Connection |
|
Limit |
Set the maximum number of activities Boost.space Integrator should return during one scenario execution cycle. |
Lists all completed or not completed activities.
Connection |
|
Limit |
Set the maximum number of activities Boost.space Integrator should return during one scenario execution cycle. |
Sort By |
Enter the option to sort the activities. For example, |
Sort Order |
Enter the order in which you want to list the activities. For example, |
Custom View ID |
Enter the Custom View ID of the activities you want to list. |
Finds an activity.
Connection |
|
Activity ID |
Select the Activity ID whose details you want to retrieve. |
Creates a new activity.
Connection |
|
Title |
Enter a name for the activity. |
Owner ID |
Select the Owner ID who owns the activity. |
Type |
Select the activity type:
|
Description |
Enter the details of the activity. |
Tags |
Enter a comma-separated list of tags for the activity. |
Due Date |
Enter the date by when the activity must be completed. |
Duration |
Enter the time spent on the activity in seconds. |
Followers |
Add the followers for the deal: Contact or User Select the option for the follower. Contact Select the contact that you want to add as a contact for the activity. User Select the contact that you want to add as a contact for the activity. |
Calendar Invite |
Select whether activity includes an activity invite:
|
Completed |
Select whether the activity is completed:
|
Updates an existing activity.
Connection |
|
Activity ID |
Select the Activity ID whose details you want to update. |
Title |
Enter a name for the activity. |
Owner ID |
Select the Owner ID who owns the activity. |
Type |
Select the activity type:
|
Description |
Enter the details of the activity. |
Tags |
Enter a comma-separated list of tags for the activity. |
Due Date |
Enter the date by when the activity must be completed. |
Duration |
Enter the time spent on the activity in seconds. |
Followers |
Add the followers for the deal: Contact or User Select the option for the follower. Contact Select the contact that you want to add as a contact for the activity. User Select the contact that you want to add as a contact for the activity. |
Calendar Invite |
Select whether activity includes an activity invite:
|
Completed |
Select whether the activity is completed:
|
Deletes an existing activity.
Connection |
|
Activity ID |
Select the Activity ID you want to delete. |
Triggers when a new contact is created.
Connection |
|
Limit |
Set the maximum number of contacts Boost.space Integrator should return during one scenario execution cycle. |
Lists all contacts.
Connection |
|
Limit |
Set the maximum number of contacts Boost.space Integrator should return during one scenario execution cycle. |
Sort By |
Enter the option to sort the activities. For example, |
Sort Order |
Enter the order in which you want to list the activities. For example, |
Custom View ID |
Enter the Custom View ID of the activities you want to list. |
Finds contact.
Connection |
|
Contact ID |
Select the Contact ID whose details you want to retrieve. |
Creates a new contact.
Connection |
|
Last Name |
Enter the last name of the contact. |
Owner ID |
Select the Owner ID of the contact. |
First Name |
Enter the first name of the contact. |
Mobile |
Enter the mobile number of the contact. |
Company ID |
Select the Company ID to which the contact belongs to. |
|
Enter the email address of the contact. |
Website |
Enter the website related to the contact. |
Google Plus Profile Link |
Enter the contact’s Google Plus link. |
LinkedIn Profile Link |
Enter the contact’s LinkedIn profile link. |
Phone number 1 |
Enter the contact’s primary phone number. |
Phone number 2 |
Enter the contact’s other alternative phone number. |
Skype ID |
Enter the contact’s Skype ID details. |
Facebook Link |
Enter the contact’s Facebook profile link. |
Twitter Link |
Enter the contact’s Twitter profile link. |
Currency |
Enter the contact’s applicable currency in a three-character format. For example, |
Designation |
Enter the contact’s position in the company. |
Address Line 1 |
Enter the contact’s billing street address. |
Address Line 2 |
Enter the contact’s billing street address. |
City |
Enter the contact’s billing city name. |
Zip Code |
Enter the contact’s billing area zip code. |
State |
Enter the contact’s billing state name. |
Country |
Enter the contact’s billing country name. |
Description |
Enter the details of the contact. |
Tags |
Enter the tags related to the contact. |
Updates an existing contact.
Connection |
|
Contact ID |
Select the Contact ID whose details you want to update. |
Last Name |
Enter the last name of the contact. |
Owner ID |
Select the Owner ID of the contact. |
First Name |
Enter the first name of the contact. |
Mobile |
Enter the mobile number of the contact. |
Company ID |
Select the Company ID to which the contact belongs to. |
|
Enter the email address of the contact. |
Website |
Enter the website related to the contact. |
Google Plus Profile Link |
Enter the contact’s Google Plus link. |
LinkedIn Profile Link |
Enter the contact’s LinkedIn profile link. |
Phone number 1 |
Enter the contact’s primary phone number. |
Phone number 2 |
Enter the contact’s other alternative phone number. |
Skype ID |
Enter the contact’s Skype ID details. |
Facebook Link |
Enter the contact’s Facebook profile link. |
Twitter Link |
Enter the contact’s Twitter profile link. |
Currency |
Enter the contact’s applicable currency in a three-character format. For example, |
Designation |
Enter the contact’s position in the company. |
Address Line 1 |
Enter the contact’s billing street address. |
Address Line 2 |
Enter the contact’s billing street address. |
City |
Enter the contact’s billing city name. |
Zip Code |
Enter the contact’s billing area zip code. |
State |
Enter the contact’s billing state name. |
Country |
Enter the contact’s billing country name. |
Description |
Enter the details of the contact. |
Tags |
Enter the tags related to the contact. |
Deletes an existing contact.
Connection |
|
Contact ID |
Select the Contact ID you want to delete. |
Triggers when a new company is created.
Connection |
|
Limit |
Set the maximum number of new companies Boost.space Integrator should return during one scenario execution cycle. |
Lists all companies.
Connection |
|
Limit |
Set the maximum number of companies Boost.space Integrator should return during one scenario execution cycle. |
Sort By |
Enter the option to sort the companies. For example, |
Sort Order |
Enter the order in which you want to list the companies. For example, |
Custom View ID |
Enter the Custom View ID of the companies you want to list. |
Gets information about a company.
Connection |
|
Company ID |
Select the Company ID whose details you want to retrieve. |
Creates a new company.
Connection |
|
Name |
Enter the name of the company. |
Owner ID |
Select the Owner ID of the company. |
Website |
Enter the company’s website URL address. |
Google Plus Profile Link |
Enter the company’s Google Plus profile link. |
LinkedIn Profile Link |
Enter the company’s LinkedIn profile link. |
Phone Number 1 |
Enter the company’s phone number. |
Phone Number 2 |
Enter the company’s alternative phone number. |
Skype ID |
Enter the company’s Skype ID details. |
Facebook Link |
Enter the company’s Facebook profile link. |
Twitter Link |
Enter the company’s Twitter profile link |
Currency |
Enter the company’s applicable currency in a three-character format. For example, |
Address Line 1 |
Enter the company’s billing street address. |
Address Line 2 |
Enter the company’s billing street address. |
City |
Enter the company’s billing city name. |
Zip Code |
Enter the company’s billing zip code. |
State |
Enter the company’s billing state name. |
Country |
Enter the company’s billing country name. |
Description |
Enter the details of the company. |
Tags |
Enter the tags related to the company. |
Updates an existing company.
Connection |
|
Company ID |
Select the Company ID whose details you want to update. |
Name |
Enter the name of the company. |
Owner ID |
Select the Owner ID of the company. |
Website |
Enter the company’s website URL address. |
Google Plus Profile Link |
Enter the company’s Google Plus profile link. |
LinkedIn Profile Link |
Enter the company’s LinkedIn profile link. |
Phone Number 1 |
Enter the company’s phone number. |
Phone Number 2 |
Enter the company’s alternative phone number. |
Skype ID |
Enter the company’s Skype ID details. |
Facebook Link |
Enter the company’s Facebook profile link. |
Twitter Link |
Enter the company’s Twitter profile link |
Currency |
Enter the company’s applicable currency in a three-character format. For example, |
Address Line 1 |
Enter the company’s billing street address. |
Address Line 2 |
Enter the company’s billing street address. |
City |
Enter the company’s billing city name. |
Zip Code |
Enter the company’s billing zip code. |
State |
Enter the company’s billing state name. |
Country |
Enter the company’s billing country name. |
Description |
Enter the details of the company. |
Tags |
Enter the tags related to the company. |
Deletes an existing company.
Connection |
|
Company ID |
Select the Company ID you want to delete. |
Performs an arbitrary authorized API call.
Connection |
||||
URL |
Enter a path relative to
|
|||
Method |
Select the HTTP method you want to use: GET to retrieve information for an entry. POST to create a new entry. PUT to update/replace an existing entry. PATCH to make a partial entry update. DELETE to delete an entry. |
|||
Headers |
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you. |
|||
Query String |
Enter the request query string. |
|||
Body |
Enter the body content for your API call. |
The following API call returns the specified company details from your Salesmate account:
URL: v2/companies/{company_id}
Method: GET
Matches of the search can be found in the module’s Output under BundleA bundle is a chunk of data and the basic unit for use with modules. A bundle consists of items, similar to how a bag may contain separate, individual items. More > Body > Data. In our example, the specified company details were returned: