Active with remarks |
---|
This application needs additional settings. Please follow the documentation below to create your connection. |
The Kartra modules allow you to create, add, remove, retrieve and list the leads, sequence, tags, subscriptions, and events in your Kartra account.
Prerequisites
-
A Kartra account
In order to use Kartra with Boost.space Integrator, it is necessary to have a Kartra account. If you do not have one, you can create a Kartra account at home.kartra.com/home.
![]() |
Note |
---|---|
The module dialog fields that are displayed in bold (in the Boost.space Integrator scenario, not in this documentation article) are mandatory! |
To connect your Kartra account to Boost.space Integrator you need to obtain the API Key from your Kartra account and insert it in the Create a connection dialog in the Boost.space Integrator module.
-
Login to your Kartra account.
-
Click My Integrations > API > My API. Copy the API key and API password to a notepad or safe place
-
Go toBoost.space Integrator and open the Kartra module’s Create a connection dialog.
-
In the Connection name field, enter a name for the connection.
-
In the API Key and API Password fields, enter the API Key and password copied in step 2. Click Continue.
The connection has been established.
Creates a new lead.
|
|
|
Enter the email address of the lead. |
|
Enter the phone number of the lead. |
|
Enter the country code of the lead. |
|
Enter the first name of the lead. |
|
Enter the middle name of the lead. |
|
Enter the last name of the lead. |
|
Enter any additional last name of the lead. |
|
Enter the IP address of the lead. |
|
Enter the contact company address of the lead. |
|
Enter the lead’s or lead’s company area zip code. |
|
Enter the lead’s or lead’s company city name. |
|
Enter the lead’s or lead’s company state name. |
|
Enter the lead’s or lead’s company’s country name. |
|
Enter the lead’s company name. |
|
Enter the URL address of the lead’s profile image. |
|
Enter the lead’s company website URL address. |
|
Enter the lead’s or lead’s company Facebook page URL address. |
|
Enter the lead’s or lead’s company Twitter page URL address. |
|
Enter the lead’s or lead’s company LinkedIn page URL address. |
|
Enter the lead’s or lead’s company Google Plus page URL address. |
|
Add the custom fields. |
Retrieves a lead.
|
|
|
Enter the email address of the lead whose details you want to retrieve. |
|
Enter the Lead ID whose details you want to retrieve. |
Removes points from a lead.
|
|
|
Enter the email address of the lead whose details you want to search. |
|
Enter the Lead ID whose details you want to retrieve. |
Adds points to a lead.
|
|
|
Enter the email address of the lead to whom you want to add the points. |
|
Enter the number of points you want to assign to the Lead. |
|
Enter the number of days after which the points expire. A value of 0 means there is no expiry date for the points assigned to the lead. |
Removes points from a lead.
|
|
|
Enter the email address of the lead whose points you want to remove. |
|
Enter the number of points you want to remove from the Lead. |
Adds a tag to a lead.
|
|
|
Enter the email address of the lead to whom you want to add the tag. |
|
Select the tag you want to add to the lead. |
Removes a tag from a lead.
|
|
|
Enter the email address of the lead to whom you want to remove the tag. |
|
Select the tag you want to remove from the lead. |
Adds a lead to a subscription list.
|
|
|
Enter the email address of the lead whom you want to add to the list. |
|
Select the list to which you want to add the lead. |
Adds a lead to a subscription list.
|
|
|
Enter the email address of the lead whom you want to add to the sequence. |
|
Select the sequence to which you want to add the lead. |
|
Enter the order number where the lead will be placed in the sequence. |
Adds a lead to a calendar.
|
|
|
Enter the email address of the lead whom you want to add to the list. |
|
Enter the calendar name to which you want to add or subscribe to the lead. |
|
Enter the class name of the lead. |
|
Enter the start date of the lead in the calendar. |
Removes lead from a list.
|
|
|
Enter the email address of the lead whom you want to remove from a list. |
|
Select the list from which you want to remove the lead. |
Removes a lead from a sequence.
|
|
|
Enter the email address of the lead whom you want to remove from the sequence. |
|
Select the sequence from which you want to remove the lead. |
Removes a lead from a calendar.
|
|
|
Enter the email address of the lead whom you want to remove from the sequence. |
|
Enter the calendar name from which you want to remove the lead. |
|
Enter the class name from which you want to remove the lead. |
Returns all lead’s transactions by lead’s e-mail.
|
|
|
Enter the email address of the lead whose transaction details you want to retrieve. |
|
Set the maximum number of transactions Boost.space Integrator should return during one scenario execution cycle. |
Checks the existence of a transaction.
|
|
|
Enter (map) the Transaction ID which you check whether it exists or not. |
Returns all lead subscriptions by lead’s e-mail.
|
|
|
Enter the email address of the lead whose subscription details you want to retrieve. |
Creates a new lead.
|
|
|
Enter the email address of the lead. |
|
Enter the phone number of the lead. |
|
Enter the country code of the lead. |
|
Enter the first name of the lead. |
|
Enter the middle name of the lead. |
|
Enter the last name of the lead. |
|
Enter any additional last name of the lead. |
|
Enter the IP address of the lead. |
|
Enter the contact company address of the lead. |
|
Enter the lead’s or lead’s company area zip code. |
|
Enter the lead’s or lead’s company city name. |
|
Enter the lead’s or lead’s company state name. |
|
Enter the lead’s or lead’s company’s country name. |
|
Enter the lead’s company name. |
|
Enter the URL address of the lead’s profile image. |
|
Enter the lead’s company website URL address. |
|
Enter the lead’s or lead’s company Facebook page URL address. |
|
Enter the lead’s or lead’s company Twitter page URL address. |
|
Enter the lead’s or lead’s company LinkedIn page URL address. |
|
Enter the lead’s or lead’s company Google Plus page URL address. |
|
Select the tags you want to add to the lead. |
|
Select the list to which you want to add to the list. |
|
Enter the number of points you want to add to the list. |
|
Enter the number of days after which the points will be automatically detected from the lead. |
|
Select the Sequence to which you want to subscribe to the lead. |
|
Enter the order in the sequence where you want to place the lead. |
|
Enter (map) the calendar name to which you want to add or subscribe to the lead. |
|
Enter the class name of the lead. |
|
Enter the start date of the lead in the calendar. |
|
Add the custom fields Key-value pair for the lead. |
Updates a lead.
|
|
|
Enter the email address of the lead. |
|
Select the Lead ID whose details you want to update. |
|
Enter the phone number of the lead. |
|
Enter the country code of the lead. |
|
Enter the first name of the lead. |
|
Enter the middle name of the lead. |
|
Enter the last name of the lead. |
|
Enter any additional last name of the lead. |
|
Enter the IP address of the lead. |
|
Enter the contact company address of the lead. |
|
Enter the lead’s or lead’s company area zip code. |
|
Enter the lead’s or lead’s company city name. |
|
Enter the lead’s or lead’s company state name. |
|
Enter the lead’s or lead’s company’s country name. |
|
Enter the lead’s company name. |
|
Enter the URL address of the lead’s profile image. |
|
Enter the lead’s company website URL address. |
|
Enter the lead’s or lead’s company Facebook page URL address. |
|
Enter the lead’s or lead’s company Twitter page URL address. |
|
Enter the lead’s or lead’s company LinkedIn page URL address. |
|
Enter the lead’s or lead’s company Google Plus page URL address. |
|
Select the tags you want to add to the lead. |
|
Select the list to which you want to add to the list. |
|
Enter the number of points you want to add to the list. |
|
Enter the number of days after which the points will be automatically detected from the lead. |
|
Select the Sequence to which you want to subscribe to the lead. |
|
Enter the order in the sequence where you want to place the lead. |
|
Enter (map) the calendar name to which you want to add or subscribe to the lead. |
|
Enter the class name of the lead. |
|
Enter the start date of the lead in the calendar. |
|
Enter the calendar name from which you want to unsubscribe the lead. |
|
Enter the class name from which you want to unsubscribe the lead. |
|
Add the custom fields Key-value pair for the lead. |
Triggers when new events happen in Kartra.
|
Enter a name for the webhook. |
|
-
Open the Watch Events module, establish a connection, and copy the URL address to your clipboard.
-
Log in to your Kartra account. Click My Integrations > API > My API > Change. Select Yes Activate Outbound API and Click Save.
-
In the URL TO SEND THE API CALL TO field, enter the URL address copied in step 1, and select the actions for which you want to receive the alerts, and click Add.
The webhook has been added.
Performs an arbitrary authorized API call.
|
|
|
Enter the desired request headers. You don’t have to add authorization headers; we already did that for you. |
|
Enter the request query string. |
|
Enter the body content for your API call. For example, the following body to retrieve all pages in your account: { "actions[][cmd]": "retrieve_account_pages" } |
![]() |
Note |
---|---|
For the list of available API calls please refer to the Kartra API documentation. |
Do you need help with something specific regarding Kartra?
We are here for you.
Get support on the road to success from real experts.
We will help you set up your business processes, create connections from your current IT stack, and set up data analysis.
Get in touch