InterAction (Preview)
LexisNexis InterAction+ is a comprehensive CRM (Customer Relationship Management) solution designed specifically for law firms. Leverage this connector to integrate third party applications with InterAction+ to automate your work, streamline tasks and strengthen client relationships.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | InterAction |
| URL | https://www.lexisnexis.com/en-us/products/interaction/default.page |
| support@interaction.com |
| Connector Metadata | |
|---|---|
| Publisher | LexisNexis Legal and Professional |
| Website | https://www.lexisnexis.com/en-us/products/interaction/default.page |
| Privacy policy | https://www.lexisnexis.com/en-us/terms/privacy-policy.page |
| Categories | Marketing |
InterAction+
LexisNexis InterAction+ is a comprehensive CRM (Customer Relationship Management) solution designed specifically for law firms. Leverage this connector to integrate third party applications with InterAction+ to automate your work, streamline tasks and strengthen client relationships.
Publisher: LexisNexis
Prerequisites
You will need the following to proceed:
- A Microsoft PowerAutomate/Flow plan.
- An account with InterAction+ with Admin access.
- InterAction+ App URL (eg.
https://example.apps.interaction.comor https://us.apps.interaction.com/example) and Region (US, AU or EU). To know more about InterAction+ and our services, get in touch with us at support@interaction.com.
Supported Operations
The connector supports the following operations:
Get Lists:Get All Lists from InterAction+ which includes workingList, marketingList and marketingListWithSponsorship.Get List By Id:Get a List detail by List Id in InterAction+.Get List By Name:Get a List detail by List Name in InterAction+.Get Additional Field Definitions And Values:Get Additional Field Definitions And Values of list from Interaction+.Add or Update Additional field values for Contact:Add or Update Additional field values for Contact in Interaction+.Get Contact By Id:Get a Contact Details by Id in InterAction+.Create Person Contact:Create Person Contact in InterAction+.Update Person Contact:Update a public person contact in InterAction+.Search Person Contact:Search person contact based on first name, last name and email address filter in InterAction+.Add Contacts to Lists:Add one or more contacts to one or more lists in InterAction+. For more than one contacts or lists switch the input mode.Remove Contacts from List:Remove Contacts from List in InterAction+.Create Activity:Create Activity in InterAction+.Update Activity:Edit or Update the Activity field value for Contact in Interaction+.
Obtaining Credentials
Request access by contacting InterAction+ Support (support@interaction.com)
Common errors and remedies
Here are some issues you could face while using the connector:
Error 400: Appears when you make a bad request, it means that you wrongly enter the parameters.Error 401: Appears when you are unauthorized to access the requested information.Error 429: Too Many Requests error that tells the client application to stop sending requests because they simply don’t have enough resources to accept it at this time.
Support
For further support, please contact support@interaction.com
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| App URL | string | InterAction+ Application URL (eg. https://us.apps.interaction.com/tpcqa) | True |
| Region | string | Select the region | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Add Contacts to Lists |
Add one or more contacts to one or more lists in InterAction+. For more than one contacts or lists switch the input mode. |
| Add or Update Additional Field Values for Contact |
Add or Update Additional Field Values for Contact in InterAction+. |
| Create Activity |
Create Activity in InterAction+. |
| Create Person Contact |
Create Person Contact in InterAction+. |
| Get Additional Field Definitions and Values |
Get Additional Field Definitions and Values of list from InterAction+. |
| Get Contact by Id |
Get Contact by Id along with Additional Field Values in InterAction+. |
| Get List by Id |
Get List by Id in InterAction+. |
| Get List by Name |
Get List by Name in InterAction+. |
| Get Lists |
Get Lists from InterAction+ which includes workingList, marketingList and marketingListWithSponsorship. |
| Remove Contacts from List |
Remove Contacts from List in InterAction+. |
| Search Person Contact |
Search person contact based on first name, last name and email address. |
| Update Activity |
Edit or Update the Activity field value for Contact in Interaction+. |
| Update Person Contact |
Update a person contact in InterAction+. |
Add Contacts to Lists
Add one or more contacts to one or more lists in InterAction+. For more than one contacts or lists switch the input mode.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List Ids
|
listIds | True | array of string |
List Id to add contact |
|
Contact Ids
|
contactIds | True | array of string |
Contact Id to add to list |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
totalCount
|
data.addContactsToLists.totalCount | integer |
totalCount |
|
successCount
|
data.addContactsToLists.successCount | integer |
successCount |
|
resultText
|
data.addContactsToLists.resultText | string |
resultText |
Add or Update Additional Field Values for Contact
Add or Update Additional Field Values for Contact in InterAction+.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Contact Id
|
contactId | True | string |
Contact Id to be updated. |
|
Field Id
|
fieldId | True | string |
Field Id of additional field. |
|
Value
|
value | True | string |
Value of additional field. |
|
Value Id
|
valueId | string |
Value Id is required only to update existing value. In case of new value leave this field empty. |
|
|
Last Edit Date
|
lastEditDate | string |
Last edited date is required only to update existing value. In case of new value leave this field empty. |
|
|
Field Data Type
|
fieldDataType | True | string |
Data type of additional field. Allowed datatypes are integer, text, boolean, decimal, user, date and list. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
models
|
data.updateListContactAdditionalFields.models | array of object |
models |
|
failureReason
|
data.updateListContactAdditionalFields.models.failureReason | string |
failureReason |
|
fieldId
|
data.updateListContactAdditionalFields.models.fieldId | string |
fieldId |
|
isSuccessful
|
data.updateListContactAdditionalFields.models.isSuccessful | boolean |
isSuccessful |
|
valueId
|
data.updateListContactAdditionalFields.models.valueId | string |
valueId |
|
__typename
|
data.updateListContactAdditionalFields.models.__typename | string |
__typename |
|
__typename
|
data.updateListContactAdditionalFields.__typename | string |
__typename |
Create Activity
Create Activity in InterAction+.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Activity Type
|
typeId | True | string |
Activity type for new activity. |
|
Activity Date
|
activityDate | True | string |
The date of the activity in string format. It accepts datetime format in YYYY-MM-DD HH:mm:ss. |
|
Subject
|
subject | True | string |
Subject of the activity. |
|
Summary
|
summary | string |
Summary of the activity. |
|
|
Linked Entity Ids
|
linkedEntityIds | True | array of string |
Contact Id representing the entities linked to the activity. It accepts GUID format 00000000-0000-0000-0000-000000000000. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
data.addActivity.id | string |
id |
Create Person Contact
Create Person Contact in InterAction+.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
First Name
|
firstName | string |
First Name. |
|
|
Middle Name
|
middleName | string |
Middle Name. |
|
|
Last Name
|
lastName | True | string |
Last Name. |
|
GoesBy
|
goesBy | string |
GoesBy. |
|
|
Title
|
title | string |
Title (Mr., Mrs., Dr., etc.). |
|
|
Email Address
|
emailAddress | string |
Business Email Address. |
|
|
Company Name
|
companyName | string |
Company Name. |
|
|
Job Title
|
jobTitle | string |
Job Title. |
|
|
Direct/Primary Phone
|
primaryPhone | string |
Direct/Primary Phone. |
|
|
Country
|
country | string |
The Country of the business address. |
|
|
Street
|
street | string |
The Street of the business address. |
|
|
City
|
city | string |
The City of the business address. |
|
|
Administrative Division/State/Region/District/Province
|
administrativeDivision | string |
Administrative Division/State/Region/District/Province. |
|
|
Postal Code
|
postalCode | string |
The Postal Code of the business address if your country does not use postal code, leave it blank. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
status
|
data.addPerson.status | string |
status |
|
id
|
data.addPerson.item.id | string |
id |
|
firstName
|
data.addPerson.item.firstName | string |
firstName |
|
lastName
|
data.addPerson.item.lastName | string |
lastName |
|
goesBy
|
data.addPerson.item.goesBy | string |
goesBy |
|
currentJobTitle
|
data.addPerson.item.currentJobTitle | string |
currentJobTitle |
|
phoneNumbers
|
data.addPerson.item.phoneNumbers | array of object |
phoneNumbers |
|
id
|
data.addPerson.item.phoneNumbers.id | string |
id |
|
number
|
data.addPerson.item.phoneNumbers.number | string |
number |
|
label
|
data.addPerson.item.phoneNumbers.label | string |
label |
|
type
|
data.addPerson.item.phoneNumbers.type | string |
type |
|
usage
|
data.addPerson.item.phoneNumbers.usage | string |
usage |
|
emailAddresses
|
data.addPerson.item.emailAddresses | array of object |
emailAddresses |
|
id
|
data.addPerson.item.emailAddresses.id | string |
id |
|
type
|
data.addPerson.item.emailAddresses.type | string |
type |
|
usage
|
data.addPerson.item.emailAddresses.usage | string |
usage |
|
address
|
data.addPerson.item.emailAddresses.address | string |
address |
|
label
|
data.addPerson.item.emailAddresses.label | string |
label |
|
validationErrors
|
data.addPerson.validationErrors | array of |
validationErrors |
Get Additional Field Definitions and Values
Get Additional Field Definitions and Values of list from InterAction+.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List Id
|
id | True | string |
List Id. |
|
Skip Contacts
|
skip | integer |
Starting point for retrieval of contacts. Default value is set to 0. |
|
|
Limit Contacts
|
limit | integer |
Number of contacts to retrieve from lists. Default value is set to 100. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
data.list.id | string |
id |
|
name
|
data.list.name | string |
name |
|
description
|
data.list.description | string |
description |
|
id
|
data.list.listType.id | string |
id |
|
isActive
|
data.list.listType.isActive | boolean |
isActive |
|
listClass
|
data.list.listType.listClass | string |
listClass |
|
name
|
data.list.listType.name | string |
name |
|
totalModels
|
data.list.additionalFieldDefinitions.totalModels | integer |
totalModels |
|
models
|
data.list.additionalFieldDefinitions.models | array of object |
models |
|
userDataTypeUserProfessional
|
data.list.additionalFieldDefinitions.models.userDataTypeUserProfessional | string |
userDataTypeUserProfessional |
|
userDataTypeUserActive
|
data.list.additionalFieldDefinitions.models.userDataTypeUserActive | string |
userDataTypeUserActive |
|
stringDataTypeMultiLine
|
data.list.additionalFieldDefinitions.models.stringDataTypeMultiLine | boolean |
stringDataTypeMultiLine |
|
stringDataTypeMaxLength
|
data.list.additionalFieldDefinitions.models.stringDataTypeMaxLength | integer |
stringDataTypeMaxLength |
|
secondaryFieldName
|
data.list.additionalFieldDefinitions.models.secondaryFieldName | string |
secondaryFieldName |
|
numericDataTypeMinValue
|
data.list.additionalFieldDefinitions.models.numericDataTypeMinValue | string |
numericDataTypeMinValue |
|
numericDataTypeMaxValue
|
data.list.additionalFieldDefinitions.models.numericDataTypeMaxValue | string |
numericDataTypeMaxValue |
|
name
|
data.list.additionalFieldDefinitions.models.name | string |
name |
|
options
|
data.list.additionalFieldDefinitions.models.listDataType.options | array of |
options |
|
id
|
data.list.additionalFieldDefinitions.models.id | string |
id |
|
fieldDataType
|
data.list.additionalFieldDefinitions.models.fieldDataType | string |
fieldDataType |
|
description
|
data.list.additionalFieldDefinitions.models.description | string |
description |
|
decimalDataTypePrecision
|
data.list.additionalFieldDefinitions.models.decimalDataTypePrecision | integer |
decimalDataTypePrecision |
|
dataTypeDisplayName
|
data.list.additionalFieldDefinitions.models.dataTypeDisplayName | string |
dataTypeDisplayName |
|
booleanDataTypeFalseValue
|
data.list.additionalFieldDefinitions.models.booleanDataTypeFalseValue | string |
booleanDataTypeFalseValue |
|
booleanDataTypeTrueValue
|
data.list.additionalFieldDefinitions.models.booleanDataTypeTrueValue | string |
booleanDataTypeTrueValue |
|
allowsSecondaryField
|
data.list.additionalFieldDefinitions.models.allowsSecondaryField | boolean |
allowsSecondaryField |
|
allowsMultipleValues
|
data.list.additionalFieldDefinitions.models.allowsMultipleValues | boolean |
allowsMultipleValues |
|
totalModels
|
data.list.contacts.totalModels | integer |
totalModels |
|
models
|
data.list.contacts.models | array of object |
models |
|
id
|
data.list.contacts.models.id | string |
id |
|
title
|
data.list.contacts.models.title | string |
title |
|
phoneNumber
|
data.list.contacts.models.phoneNumber | string |
phoneNumber |
|
emailAddress
|
data.list.contacts.models.emailAddress | string |
emailAddress |
|
displayName
|
data.list.contacts.models.displayName | string |
displayName |
|
companyName
|
data.list.contacts.models.companyName | string |
companyName |
|
companyId
|
data.list.contacts.models.companyId | string |
companyId |
|
contactEntity
|
data.list.contacts.models.contactEntity | string |
contactEntity |
|
displayName
|
data.list.contacts.models.sponsors.displayName | string |
displayName |
|
fullName
|
data.list.contacts.models.sponsors.fullName | string |
fullName |
|
id
|
data.list.contacts.models.sponsors.id | string |
id |
|
isPrimary
|
data.list.contacts.models.sponsors.isPrimary | boolean |
isPrimary |
|
totalModels
|
data.list.contacts.models.additionalFieldValues.totalModels | integer |
totalModels |
|
models
|
data.list.contacts.models.additionalFieldValues.models | array of object |
models |
|
contactId
|
data.list.contacts.models.additionalFieldValues.models.contactId | string |
contactId |
|
dataType
|
data.list.contacts.models.additionalFieldValues.models.dataType | string |
dataType |
|
fieldDisplayName
|
data.list.contacts.models.additionalFieldValues.models.fieldDisplayName | string |
fieldDisplayName |
|
fieldId
|
data.list.contacts.models.additionalFieldValues.models.fieldId | string |
fieldId |
|
format
|
data.list.contacts.models.additionalFieldValues.models.format | string |
format |
|
id
|
data.list.contacts.models.additionalFieldValues.models.id | string |
id |
|
listId
|
data.list.contacts.models.additionalFieldValues.models.listId | string |
listId |
|
separator
|
data.list.contacts.models.additionalFieldValues.models.separator | string |
separator |
|
valueItems
|
data.list.contacts.models.additionalFieldValues.models.valueItems | array of object |
valueItems |
|
lastEditDate
|
data.list.contacts.models.additionalFieldValues.models.valueItems.lastEditDate | string |
lastEditDate |
|
qualification
|
data.list.contacts.models.additionalFieldValues.models.valueItems.qualification | string |
qualification |
|
value
|
data.list.contacts.models.additionalFieldValues.models.valueItems.value | string |
value |
|
valueId
|
data.list.contacts.models.additionalFieldValues.models.valueItems.valueId | string |
valueId |
Get Contact by Id
Get Contact by Id along with Additional Field Values in InterAction+.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Contact Id
|
contactid | True | string |
Contact Id. |
|
List Id
|
listid | True | string |
List Id can't be null and default value is set to 00000000-0000-0000-0000-000000000000. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
contactId
|
data.contact.contactId | string |
contactId |
|
displayName
|
data.contact.displayName | string |
displayName |
|
title
|
data.contact.title | string |
title |
|
firstName
|
data.contact.firstName | string |
firstName |
|
middleName
|
data.contact.middleName | string |
middleName |
|
lastName
|
data.contact.lastName | string |
lastName |
|
goesBy
|
data.contact.goesBy | string |
goesBy |
|
contactEntity
|
data.contact.contactEntity | string |
contactEntity |
|
currentJobTitle
|
data.contact.currentJobTitle | string |
currentJobTitle |
|
companyName
|
data.contact.currentEmployer.companyName | string |
companyName |
|
companyId
|
data.contact.currentEmployer.companyId | string |
companyId |
|
totalModels
|
data.contact.additionalFieldValues.totalModels | integer |
totalModels |
|
models
|
data.contact.additionalFieldValues.models | array of object |
models |
|
contactId
|
data.contact.additionalFieldValues.models.contactId | string |
contactId |
|
dataType
|
data.contact.additionalFieldValues.models.dataType | string |
dataType |
|
fieldId
|
data.contact.additionalFieldValues.models.fieldId | string |
fieldId |
|
fieldDisplayName
|
data.contact.additionalFieldValues.models.fieldDisplayName | string |
fieldDisplayName |
|
additionalFieldValueId
|
data.contact.additionalFieldValues.models.additionalFieldValueId | string |
additionalFieldValueId |
|
listId
|
data.contact.additionalFieldValues.models.listId | string |
listId |
|
valueItems
|
data.contact.additionalFieldValues.models.valueItems | array of object |
valueItems |
|
lastEditDate
|
data.contact.additionalFieldValues.models.valueItems.lastEditDate | string |
lastEditDate |
|
value
|
data.contact.additionalFieldValues.models.valueItems.value | string |
value |
|
valueId
|
data.contact.additionalFieldValues.models.valueItems.valueId | string |
valueId |
|
addresses
|
data.contact.addresses | array of object | |
|
id
|
data.contact.addresses.id | string |
addressId |
|
street
|
data.contact.addresses.street | string |
street |
|
city
|
data.contact.addresses.city | string |
city |
|
administrativeDivision
|
data.contact.addresses.administrativeDivision | string |
administrativeDivision |
|
country
|
data.contact.addresses.country | string |
country |
|
postalCode
|
data.contact.addresses.postalCode | string |
postalCode |
|
type
|
data.contact.addresses.type | string |
type |
|
usage
|
data.contact.addresses.usage | string |
usage |
|
visibility
|
data.contact.visibility | string |
visibility |
|
emailAddresses
|
data.contact.emailAddresses | array of object |
emailAddresses |
|
emailId
|
data.contact.emailAddresses.emailId | string |
emailId |
|
type
|
data.contact.emailAddresses.type | string |
type |
|
usage
|
data.contact.emailAddresses.usage | string |
usage |
|
address
|
data.contact.emailAddresses.address | string |
address |
|
label
|
data.contact.emailAddresses.label | string |
label |
|
owningContactId
|
data.contact.emailAddresses.owningContactId | string |
owningContactId |
|
isGlobal
|
data.contact.emailAddresses.isGlobal | boolean |
isGlobal |
|
phoneNumbers
|
data.contact.phoneNumbers | array of object |
phoneNumbers |
|
phoneId
|
data.contact.phoneNumbers.phoneId | string |
phoneId |
|
number
|
data.contact.phoneNumbers.number | string |
number |
|
label
|
data.contact.phoneNumbers.label | string |
label |
|
type
|
data.contact.phoneNumbers.type | string |
type |
|
usage
|
data.contact.phoneNumbers.usage | string |
usage |
|
owningContactId
|
data.contact.phoneNumbers.owningContactId | string |
owningContactId |
|
isGlobal
|
data.contact.phoneNumbers.isGlobal | boolean |
isGlobal |
|
skip
|
data.contact.activities.skip | integer |
skip |
|
limit
|
data.contact.activities.limit | integer |
limit |
|
totalModels
|
data.contact.activities.totalModels | integer |
totalModels |
|
models
|
data.contact.activities.models | array of object |
models |
|
activityId
|
data.contact.activities.models.activityId | string |
activityId |
|
type
|
data.contact.activities.models.type | string |
type |
|
typeId
|
data.contact.activities.models.typeId | string |
typeId |
|
activityClass
|
data.contact.activities.models.activityClass | string |
activityClass |
|
typeGroup
|
data.contact.activities.models.typeGroup | string |
typeGroup |
|
activityStartDate
|
data.contact.activities.models.activityStartDate | string |
activityStartDate |
|
lastEditedDate
|
data.contact.activities.models.lastEditedDate | string |
lastEditedDate |
|
subject
|
data.contact.activities.models.subject | string |
subject |
|
summary
|
data.contact.activities.models.summary | string |
summary |
|
location
|
data.contact.activities.models.location | string |
location |
|
totalModels
|
data.contact.notes.allNotes.totalModels | integer |
totalModels |
|
models
|
data.contact.notes.allNotes.models | array of object |
models |
|
changeDate
|
data.contact.notes.allNotes.models.changeDate | string |
changeDate |
|
folderId
|
data.contact.notes.allNotes.models.folderId | string |
folderId |
|
noteId
|
data.contact.notes.allNotes.models.noteId | string |
noteId |
|
notes
|
data.contact.notes.allNotes.models.notes | string |
notes |
|
totalModels
|
data.contact.lists.totalModels | integer |
totalModels |
|
models
|
data.contact.lists.models | array of object |
models |
|
listId
|
data.contact.lists.models.listId | string |
listId |
|
name
|
data.contact.lists.models.name | string |
name |
|
listClass
|
data.contact.lists.models.listClass | string |
listClass |
|
description
|
data.contact.lists.models.description | string |
description |
|
type
|
data.contact.lists.models.type | string |
type |
|
userIsSponsor
|
data.contact.lists.models.userIsSponsor | boolean |
userIsSponsor |
|
allowedLinkInto
|
data.contact.lists.models.allowedLinkInto | boolean |
allowedLinkInto |
|
allowedRemoveFrom
|
data.contact.lists.models.allowedRemoveFrom | boolean |
allowedRemoveFrom |
|
ownerName
|
data.contact.lists.models.ownerName | string |
ownerName |
|
creatorName
|
data.contact.lists.models.creatorName | string |
creatorName |
|
sponsors
|
data.contact.lists.models.sponsors | array of object |
sponsors |
|
sponsorId
|
data.contact.lists.models.sponsors.sponsorId | string |
sponsorId |
|
displayName
|
data.contact.lists.models.sponsors.displayName | string |
displayName |
|
isPrimary
|
data.contact.lists.models.sponsors.isPrimary | boolean |
isPrimary |
|
fullName
|
data.contact.lists.models.sponsors.fullName | string |
fullName |
Get List by Id
Get List by Id in InterAction+.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List Id
|
id | True | string |
List Id. |
|
Skip Contacts
|
skip | integer |
Starting point for retrieval of contacts. Default value is set to 0. |
|
|
Limit Contacts
|
limit | integer |
Number of contacts to retrieve from lists. Default value is set to 100. |
|
|
Primary Sponsor Name
|
primarySponsorName | string |
Filter list contacts with Primary Sponsor Name which exactly match with display name of the contact. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
data.list.id | string |
id |
|
name
|
data.list.name | string |
name |
|
description
|
data.list.description | string |
description |
|
id
|
data.list.listType.id | string |
id |
|
isActive
|
data.list.listType.isActive | boolean |
isActive |
|
listClass
|
data.list.listType.listClass | string |
listClass |
|
name
|
data.list.listType.name | string |
name |
|
allowedLinkInto
|
data.list.allowedLinkInto | boolean |
allowedLinkInto |
|
allowedRemoveFrom
|
data.list.allowedRemoveFrom | boolean |
allowedRemoveFrom |
|
addAllowed
|
data.list.addAllowed | boolean |
addAllowed |
|
deleteAllowed
|
data.list.deleteAllowed | boolean |
deleteAllowed |
|
addActivityAllowed
|
data.list.addActivityAllowed | boolean |
addActivityAllowed |
|
addNoteAllowed
|
data.list.addNoteAllowed | boolean |
addNoteAllowed |
|
ownerName
|
data.list.ownerName | string |
ownerName |
|
creatorName
|
data.list.creatorName | string |
creatorName |
|
allowedContactEntity
|
data.list.allowedContactEntity | string |
allowedContactEntity |
|
isAdministrator
|
data.list.isAdministrator | boolean |
isAdministrator |
|
totalModels
|
data.list.contacts.totalModels | integer |
totalModels |
|
models
|
data.list.contacts.models | array of object |
models |
|
id
|
data.list.contacts.models.id | string |
id |
|
title
|
data.list.contacts.models.title | string |
title |
|
phoneNumber
|
data.list.contacts.models.phoneNumber | string |
phoneNumber |
|
emailAddress
|
data.list.contacts.models.emailAddress | string |
emailAddress |
|
displayName
|
data.list.contacts.models.displayName | string |
displayName |
|
companyName
|
data.list.contacts.models.companyName | string |
companyName |
|
companyId
|
data.list.contacts.models.companyId | string |
companyId |
|
contactEntity
|
data.list.contacts.models.contactEntity | string |
contactEntity |
|
displayName
|
data.list.contacts.models.sponsors.displayName | string |
displayName |
|
fullName
|
data.list.contacts.models.sponsors.fullName | string |
fullName |
|
id
|
data.list.contacts.models.sponsors.id | string |
id |
|
isPrimary
|
data.list.contacts.models.sponsors.isPrimary | boolean |
isPrimary |
Get List by Name
Get List by Name in InterAction+.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List Name
|
filterByName | True | string |
List Name (Retrieves the list that exactly matches the specified name). |
|
Skip Contacts
|
skip | integer |
Starting point for retrieval of contacts. Default value is set to 0. |
|
|
Limit Contacts
|
limit | integer |
Number of contacts to retrieve from lists. Default value is set to 100. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
totalModels
|
data.lists.totalModels | integer |
totalModels |
|
models
|
data.lists.models | array of object |
models |
|
id
|
data.lists.models.id | string |
id |
|
name
|
data.lists.models.name | string |
name |
|
description
|
data.lists.models.description | string |
description |
|
id
|
data.lists.models.listType.id | string |
id |
|
isActive
|
data.lists.models.listType.isActive | boolean |
isActive |
|
listClass
|
data.lists.models.listType.listClass | string |
listClass |
|
name
|
data.lists.models.listType.name | string |
name |
|
allowedLinkInto
|
data.lists.models.allowedLinkInto | boolean |
allowedLinkInto |
|
allowedRemoveFrom
|
data.lists.models.allowedRemoveFrom | boolean |
allowedRemoveFrom |
|
addAllowed
|
data.lists.models.addAllowed | boolean |
addAllowed |
|
deleteAllowed
|
data.lists.models.deleteAllowed | boolean |
deleteAllowed |
|
addActivityAllowed
|
data.lists.models.addActivityAllowed | boolean |
addActivityAllowed |
|
addNoteAllowed
|
data.lists.models.addNoteAllowed | boolean |
addNoteAllowed |
|
ownerName
|
data.lists.models.ownerName | string |
ownerName |
|
creatorName
|
data.lists.models.creatorName | string |
creatorName |
|
allowedContactEntity
|
data.lists.models.allowedContactEntity | string |
allowedContactEntity |
|
isAdministrator
|
data.lists.models.isAdministrator | boolean |
isAdministrator |
|
totalModels
|
data.lists.models.contacts.totalModels | integer |
totalModels |
|
models
|
data.lists.models.contacts.models | array of object |
models |
|
id
|
data.lists.models.contacts.models.id | string |
id |
|
title
|
data.lists.models.contacts.models.title | string |
title |
|
phoneNumber
|
data.lists.models.contacts.models.phoneNumber | string |
phoneNumber |
|
emailAddress
|
data.lists.models.contacts.models.emailAddress | string |
emailAddress |
|
displayName
|
data.lists.models.contacts.models.displayName | string |
displayName |
|
companyName
|
data.lists.models.contacts.models.companyName | string |
companyName |
|
companyId
|
data.lists.models.contacts.models.companyId | string |
companyId |
|
contactEntity
|
data.lists.models.contacts.models.contactEntity | string |
contactEntity |
|
displayName
|
data.lists.models.contacts.models.sponsors.displayName | string |
displayName |
|
fullName
|
data.lists.models.contacts.models.sponsors.fullName | string |
fullName |
|
id
|
data.lists.models.contacts.models.sponsors.id | string |
id |
|
isPrimary
|
data.lists.models.contacts.models.sponsors.isPrimary | boolean |
isPrimary |
Get Lists
Get Lists from InterAction+ which includes workingList, marketingList and marketingListWithSponsorship.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
List Class
|
listClass | string |
The classification type of list. |
|
|
Skip Lists
|
skip | integer |
Starting point for retrieval of lists. Default value is set to 0. |
|
|
Limit Lists
|
limit | integer |
Number of lists to retrieve. Default value is set to 100. |
|
|
List Name
|
filterByName | string |
List Name (Retrieves lists that contains the specified name). |
Returns
- Body
- ListResponse
Remove Contacts from List
Remove Contacts from List in InterAction+.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Contact Ids
|
contactIds | True | array of string |
Contact Id to remove from a list. |
|
List Id
|
listId | True | string |
List Id to remove contacts from. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
resultText
|
data.removeContactsFromList.resultText | string |
resultText |
|
pendingContactsEffected
|
data.removeContactsFromList.pendingContactsEffected | integer |
pendingContactsEffected |
|
contactsEffected
|
data.removeContactsFromList.contactsEffected | integer |
contactsEffected |
Search Person Contact
Search person contact based on first name, last name and email address.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Search by Email Address
|
emailAddress | string |
Search person contacts with email address. |
|
|
Search by First Name
|
firstName | string |
Search person contacts with first name. |
|
|
Search by Last Name
|
lastName | string |
Search person contacts with last name |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
totalModels
|
data.searchFirmContacts.totalModels | integer |
totalModels |
|
models
|
data.searchFirmContacts.models | array of object |
models |
|
contactId
|
data.searchFirmContacts.models.contactId | string |
contactId |
|
displayName
|
data.searchFirmContacts.models.displayName | string |
displayName |
|
contactEntity
|
data.searchFirmContacts.models.contactEntity | string |
contactEntity |
|
title
|
data.searchFirmContacts.models.title | string |
title |
|
firstName
|
data.searchFirmContacts.models.firstName | string |
firstName |
|
middleName
|
data.searchFirmContacts.models.middleName | string |
middleName |
|
lastName
|
data.searchFirmContacts.models.lastName | string |
lastName |
|
currentJobTitle
|
data.searchFirmContacts.models.currentJobTitle | string |
currentJobTitle |
|
companyName
|
data.searchFirmContacts.models.currentEmployer.companyName | string |
companyName |
|
companyId
|
data.searchFirmContacts.models.currentEmployer.companyId | string |
companyId |
|
addresses
|
data.searchFirmContacts.models.addresses | array of object |
addresses |
|
addressID
|
data.searchFirmContacts.models.addresses.addressID | string |
addressID |
|
street
|
data.searchFirmContacts.models.addresses.street | string |
street |
|
city
|
data.searchFirmContacts.models.addresses.city | string |
city |
|
administrativeDivision
|
data.searchFirmContacts.models.addresses.administrativeDivision | string |
administrativeDivision |
|
country
|
data.searchFirmContacts.models.addresses.country | string |
country |
|
postalCode
|
data.searchFirmContacts.models.addresses.postalCode | string |
postalCode |
|
type
|
data.searchFirmContacts.models.addresses.type | string |
type |
|
usage
|
data.searchFirmContacts.models.addresses.usage | string |
usage |
|
visibility
|
data.searchFirmContacts.models.visibility | string |
visibility |
|
emailAddresses
|
data.searchFirmContacts.models.emailAddresses | array of object |
emailAddresses |
|
emailId
|
data.searchFirmContacts.models.emailAddresses.emailId | string |
emailId |
|
type
|
data.searchFirmContacts.models.emailAddresses.type | string |
type |
|
usage
|
data.searchFirmContacts.models.emailAddresses.usage | string |
usage |
|
address
|
data.searchFirmContacts.models.emailAddresses.address | string |
address |
|
label
|
data.searchFirmContacts.models.emailAddresses.label | string |
label |
|
owningContactId
|
data.searchFirmContacts.models.emailAddresses.owningContactId | string |
owningContactId |
|
isGlobal
|
data.searchFirmContacts.models.emailAddresses.isGlobal | boolean |
isGlobal |
|
phoneNumbers
|
data.searchFirmContacts.models.phoneNumbers | array of object |
phoneNumbers |
|
phoneId
|
data.searchFirmContacts.models.phoneNumbers.phoneId | string |
phoneId |
|
number
|
data.searchFirmContacts.models.phoneNumbers.number | string |
number |
|
label
|
data.searchFirmContacts.models.phoneNumbers.label | string |
label |
|
type
|
data.searchFirmContacts.models.phoneNumbers.type | string |
type |
|
usage
|
data.searchFirmContacts.models.phoneNumbers.usage | string |
usage |
|
owningContactId
|
data.searchFirmContacts.models.phoneNumbers.owningContactId | string |
owningContactId |
|
isGlobal
|
data.searchFirmContacts.models.phoneNumbers.isGlobal | boolean |
isGlobal |
|
skip
|
data.searchFirmContacts.models.activities.skip | integer |
skip |
|
limit
|
data.searchFirmContacts.models.activities.limit | integer |
limit |
|
totalModels
|
data.searchFirmContacts.models.activities.totalModels | integer |
totalModels |
|
models
|
data.searchFirmContacts.models.activities.models | array of object |
models |
|
activityId
|
data.searchFirmContacts.models.activities.models.activityId | string |
activityId |
|
type
|
data.searchFirmContacts.models.activities.models.type | string |
type |
|
typeId
|
data.searchFirmContacts.models.activities.models.typeId | string |
typeId |
|
activityClass
|
data.searchFirmContacts.models.activities.models.activityClass | string |
activityClass |
|
typeGroup
|
data.searchFirmContacts.models.activities.models.typeGroup | string |
typeGroup |
|
activityStartDate
|
data.searchFirmContacts.models.activities.models.activityStartDate | string |
activityStartDate |
|
lastEditedDate
|
data.searchFirmContacts.models.activities.models.lastEditedDate | string |
lastEditedDate |
|
subject
|
data.searchFirmContacts.models.activities.models.subject | string |
subject |
|
summary
|
data.searchFirmContacts.models.activities.models.summary | string |
summary |
|
location
|
data.searchFirmContacts.models.activities.models.location | string |
location |
|
totalModels
|
data.searchFirmContacts.models.notes.allNotes.totalModels | integer |
totalModels |
|
models
|
data.searchFirmContacts.models.notes.allNotes.models | array of |
models |
|
totalModels
|
data.searchFirmContacts.models.lists.totalModels | integer |
totalModels |
|
models
|
data.searchFirmContacts.models.lists.models | array of object |
models |
|
listId
|
data.searchFirmContacts.models.lists.models.listId | string |
listId |
|
name
|
data.searchFirmContacts.models.lists.models.name | string |
name |
|
listClass
|
data.searchFirmContacts.models.lists.models.listClass | string |
listClass |
|
description
|
data.searchFirmContacts.models.lists.models.description | string |
description |
|
type
|
data.searchFirmContacts.models.lists.models.type | string |
type |
|
userIsSponsor
|
data.searchFirmContacts.models.lists.models.userIsSponsor | boolean |
userIsSponsor |
|
allowedLinkInto
|
data.searchFirmContacts.models.lists.models.allowedLinkInto | boolean |
allowedLinkInto |
|
allowedRemoveFrom
|
data.searchFirmContacts.models.lists.models.allowedRemoveFrom | boolean |
allowedRemoveFrom |
|
ownerName
|
data.searchFirmContacts.models.lists.models.ownerName | string |
ownerName |
|
creatorName
|
data.searchFirmContacts.models.lists.models.creatorName | string |
creatorName |
|
sponsors
|
data.searchFirmContacts.models.lists.models.sponsors | array of object |
sponsors |
|
sponsorId
|
data.searchFirmContacts.models.lists.models.sponsors.sponsorId | string |
sponsorId |
|
displayName
|
data.searchFirmContacts.models.lists.models.sponsors.displayName | string |
displayName |
|
isPrimary
|
data.searchFirmContacts.models.lists.models.sponsors.isPrimary | boolean |
isPrimary |
|
fullName
|
data.searchFirmContacts.models.lists.models.sponsors.fullName | string |
fullName |
Update Activity
Edit or Update the Activity field value for Contact in Interaction+.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Activity Id
|
activityId | True | string |
Activity Id, it accepts GUID format type 00000000-0000-0000-0000-000000000000. |
|
Activity Type
|
typeId | True | string |
Activity type for update activity. |
|
Activity Date
|
activityDate | string |
The date of the activity in string format. It accepts datetime format in YYYY-MM-DD HH:mm:ss. |
|
|
Subject
|
subject | string |
Subject of the activity. |
|
|
Summary
|
summary | string |
Summary of the activity. |
|
|
Linked Entity Ids
|
linkedEntityIds | True | array of string |
Contact Id representing the entities linked to the activity. It accepts GUID format 00000000-0000-0000-0000-000000000000. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
validationErrors
|
data.updateActivity.validationErrors | array of |
validationErrors |
|
id
|
data.updateActivity.item.id | string |
id |
|
type
|
data.updateActivity.item.type | string |
type |
|
typeId
|
data.updateActivity.item.typeId | string |
typeId |
|
activityClass
|
data.updateActivity.item.activityClass | string |
activityClass |
|
typeGroup
|
data.updateActivity.item.typeGroup | string |
typeGroup |
|
activityStartDate
|
data.updateActivity.item.activityStartDate | string |
activityStartDate |
|
lastEditedDate
|
data.updateActivity.item.lastEditedDate | string |
lastEditedDate |
|
subject
|
data.updateActivity.item.subject | string |
subject |
|
summary
|
data.updateActivity.item.summary | string |
summary |
|
location
|
data.updateActivity.item.location | string |
location |
|
regarding
|
data.updateActivity.item.regarding | string |
regarding |
Update Person Contact
Update a person contact in InterAction+.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Contact Id
|
id | True | string |
Contact Id of the person. |
|
Title
|
title | string |
Title (Mr., Mrs., Dr., etc.). |
|
|
First Name
|
firstName | string |
First Name. |
|
|
Middle Name
|
middleName | string |
Middle Name. |
|
|
Last Name
|
lastName | True | string |
Last Name of the person. |
|
GoesBy
|
goesBy | string |
Common Name. |
|
|
Job Title
|
jobTitle | string |
Job Title. |
|
|
Street
|
street | string |
Street. |
|
|
City
|
city | string |
City. |
|
|
Administrative Division/State/Region/District/Province
|
administrativeDivision | string |
Administrative Division/State/Region/District/Province. |
|
|
Country
|
country | string |
To update Country, City field is also required. |
|
|
Postal Code
|
postalCode | string |
The Postal Code of the business address if your country does not use postal code, leave it blank. |
|
|
Email Address
|
electronicAddress | string |
Business Email Address. |
|
|
Direct/Primary Phone
|
number | string |
Direct/Primary Phone. |
|
|
Company Name
|
companyName | string |
Company Name. |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
data.updatePublicPerson.item.id | string |
id |
|
status
|
data.updatePublicPerson.status | string |
status |
|
validationErrors
|
data.updatePublicPerson.validationErrors | array of |
validationErrors |
Definitions
ListResponse
| Name | Path | Type | Description |
|---|---|---|---|
|
skip
|
data.lists.skip | integer |
skip |
|
limit
|
data.lists.limit | integer |
limit |
|
totalModels
|
data.lists.totalModels | integer |
totalModels |
|
models
|
data.lists.models | array of object |
models |
|
id
|
data.lists.models.id | string |
id |
|
name
|
data.lists.models.name | string |
name |
|
description
|
data.lists.models.description | string |
description |
|
id
|
data.lists.models.listType.id | string |
id |
|
isActive
|
data.lists.models.listType.isActive | boolean |
isActive |
|
listClass
|
data.lists.models.listType.listClass | string |
listClass |
|
name
|
data.lists.models.listType.name | string |
name |
|
allowedLinkInto
|
data.lists.models.allowedLinkInto | boolean |
allowedLinkInto |
|
allowedRemoveFrom
|
data.lists.models.allowedRemoveFrom | boolean |
allowedRemoveFrom |
|
addAllowed
|
data.lists.models.addAllowed | boolean |
addAllowed |
|
deleteAllowed
|
data.lists.models.deleteAllowed | boolean |
deleteAllowed |
|
addActivityAllowed
|
data.lists.models.addActivityAllowed | boolean |
addActivityAllowed |
|
addNoteAllowed
|
data.lists.models.addNoteAllowed | boolean |
addNoteAllowed |
|
ownerName
|
data.lists.models.ownerName | string |
ownerName |
|
creatorName
|
data.lists.models.creatorName | string |
creatorName |
|
allowedContactEntity
|
data.lists.models.allowedContactEntity | string |
allowedContactEntity |
|
isAdministrator
|
data.lists.models.isAdministrator | boolean |
isAdministrator |