Impexium (Preview)

Impexium is the premier association management software solution for nonprofits and member-based organizations.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   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)
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)
Contact
Name Impexium Support
URL https://support.impexium.com
Email support@impexium.com
Connector Metadata
Publisher Impexium Corporation
Website http://wwww.impexium.com
Privacy policy https://www.impexium.com/impexium-information-security-policy/
Categories Sales and CRM

This connector allows Impexium clients to create automated workflows between the suite of Impexium apps as well as 3rd party services to get notifications, synchronize files, collect data and more.

Prerequisites

To use this connector, you must have an Impexium account with access to one or more Impexium environments.

How to get credentials

Please contact support@impexium.com to get your API key

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
API URL string Specify your API Url e.g. https://abc.mpxapi.com True
API Key securestring The API Key for your environment True

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Add Activity

Add Activity

Add Individual

Adds an Individual

Add Individual to Committee

Add Individual to Committee

Add Organization

Add Organization

Add Relationship to Individual

Add Relationship to Individual

Find Customer by Phone Number

Find Customer by Phone Number

Find Individual by ID or Email or Record Number

Find Individual by ID or Email

Update Custom Field Value

Update Custom Field Value

Update Organization

Update Organization

Add Activity

Add Activity

Parameters

Name Key Required Type Description
Individual ID
id True string

Individual ID

Text
text True string

Text

Url
url string

url

Activity Date
activityDate string

Activity Date

Returns

Add Individual

Adds an Individual

Parameters

Name Key Required Type Description
Create User.
createUser string

Choose True if a user account should be created when the individual is created.

First Name
firstName True string

First Name

Last Name
lastName True string

Last Name

Email Address
email string

Email Address

Returns

Add Individual to Committee

Add Individual to Committee

Parameters

Name Key Required Type Description
Committee Code
code True string

Committee Code

Record Number
recordNumber True string

Record Number

Code
code string

Member code

Position Code
positionCode True string

Position Code

Start Date
startDate True string

Start Date

Returns

Name Path Type Description
Member Id
id string

MemberId

First Name
firstName string

FirstName

Last Name
lastName string

LastName

Code
code string

Code

Record Number
recordNumber string

RecordNumber

Position
position string

Position

Position Code
positionCode string

PositionCode

Start Date
startDate string

StartDate

End Date
endDate string

EndDate

ContactIds
primaryOrganization.contactIds array of uuid

PrimaryOrganization-ContactIds

Parent Company Id
primaryOrganization.parentCompanyId string

PrimaryOrganization-ParentCompanyId

Description
primaryOrganization.description string

PrimaryOrganization-Description

Branch Name
primaryOrganization.branchName string

PrimaryOrganization-BranchName

Tags
primaryOrganization.tags array of string

PrimaryOrganization-Tags

Primary Organization Id
primaryOrganization.id string

PrimaryOrganization-PrimaryOrganizationId

Customer Type
primaryOrganization.customerType string

PrimaryOrganization-CustomerType

Record Number
primaryOrganization.recordNumber string

PrimaryOrganization-RecordNumber

Title
primaryOrganization.title string

PrimaryOrganization-Title

Name
primaryOrganization.name string

PrimaryOrganization-Name

addresses
primaryOrganization.addresses array of object
Address Id
primaryOrganization.addresses.id string

PrimaryOrganization-Addresses-AddressId

Is Primary Address
primaryOrganization.addresses.primary boolean

PrimaryOrganization-Addresses-PrimaryAddress

Address Line 1
primaryOrganization.addresses.line1 string

PrimaryOrganization-Addresses-Line1

Address Line 2
primaryOrganization.addresses.line2 string

PrimaryOrganization-Addresses-Line2

Address Line 3
primaryOrganization.addresses.line3 string

PrimaryOrganization-Addresses-Line3

City
primaryOrganization.addresses.city string

PrimaryOrganization-Addresses-City

State
primaryOrganization.addresses.state string

PrimaryOrganization-Addresses-State

Zip Code
primaryOrganization.addresses.zipcode string

PrimaryOrganization-Addresses-ZipCode

Country
primaryOrganization.addresses.country string

PrimaryOrganization-Addresses-Country

State Abbreviation
primaryOrganization.addresses.stateAbbreviation string

PrimaryOrganization-Addresses-StateAbbreviation

State ISO Code
primaryOrganization.addresses.stateISOCode string

PrimaryOrganization-Addresses-StateISOCode

Type
primaryOrganization.addresses.type string

PrimaryOrganization-Addresses-Type

Region
primaryOrganization.addresses.region string

PrimaryOrganization-Addresses-Region

Latitude
primaryOrganization.addresses.latitude number

PrimaryOrganization-Addresses-Latitude

Longitude
primaryOrganization.addresses.longitude number

PrimaryOrganization-Addresses-Longitude

Show In Directory
primaryOrganization.addresses.showInDirectory boolean

PrimaryOrganization-Addresses-ShowInDirectory

Congressional District
primaryOrganization.addresses.congressionalDistrict string

PrimaryOrganization-Addresses-CongressionalDistrict

Country Id
primaryOrganization.addresses.countryData.id string

PrimaryOrganization-Addresses-Country-CountryId

Country Name
primaryOrganization.addresses.countryData.name string

PrimaryOrganization-Addresses-Country-CountryName

Two Letter ISO Code
primaryOrganization.addresses.countryData.twoLetterIsoCode string

PrimaryOrganization-Addresses-Country-TwoLetterIsoCode

Three Letter ISO Code
primaryOrganization.addresses.countryData.threeLetterIsoCode string

PrimaryOrganization-Addresses-Country-ThreeLetterIsoCode

Country Code
primaryOrganization.addresses.countryData.code integer

PrimaryOrganization-Addresses-Country-CountryCode

Email
primaryOrganization.email string

PrimaryOrganization-Email

Image Uri
primaryOrganization.imageUri string

PrimaryOrganization-ImageUri

Twitter
primaryOrganization.twitter string

PrimaryOrganization-Twitter

LinkedIn
primaryOrganization.linkedIn string

PrimaryOrganization-LinkedIn

emails
primaryOrganization.emails array of object
Is Primary Email
primaryOrganization.emails.primary boolean

PrimaryOrganization-Emails-Primary

Address
primaryOrganization.emails.address string

PrimaryOrganization-Emails-Address

Type
primaryOrganization.emails.type string

PrimaryOrganization-Emails-Type

Show In Directory
primaryOrganization.emails.showInDirectory boolean

PrimaryOrganization-Emails-ShowInDirectory

phones
primaryOrganization.phones array of object
Phone Id
primaryOrganization.phones.id string

PrimaryOrganization-Phones-Id

Is Primary Phone
primaryOrganization.phones.primary boolean

PrimaryOrganization-Phones-Primary

Type
primaryOrganization.phones.type integer

PrimaryOrganization-Phones-Type

Country Id
primaryOrganization.phones.country.id string

PrimaryOrganization-Phones-Country-CountryId

Country Name
primaryOrganization.phones.country.name string

PrimaryOrganization-Phones-Country-CountryName

Two Letter ISO Code
primaryOrganization.phones.country.twoLetterIsoCode string

PrimaryOrganization-Phones-Country-TwoLetterIsoCode

Three Letter ISO Code
primaryOrganization.phones.country.threeLetterIsoCode string

PrimaryOrganization-Phones-Country-ThreeLetterIsoCode

Country Code
primaryOrganization.phones.country.code integer

PrimaryOrganization-Phones-Country-CountryCode

Show In Directory
primaryOrganization.phones.showInDirectory boolean

PrimaryOrganization-Phones-ShowInDirectory

Number
primaryOrganization.phones.number string

PrimaryOrganization-Phones-Number

Extension
primaryOrganization.phones.extension string

PrimaryOrganization-Phones-Extension

Type Name
primaryOrganization.phones.typeName string

PrimaryOrganization-Phones-TypeName

WebSite
primaryOrganization.webSite string

PrimaryOrganization-WebSite

memberships
primaryOrganization.memberships array of object
Membership Type
primaryOrganization.memberships.membershipType string

PrimaryOrganization-Memberships-MembershipType

Membership Type Id
primaryOrganization.memberships.membershipTypeId string

PrimaryOrganization-Memberships-MembershipTypeId

Code
primaryOrganization.memberships.code string

PrimaryOrganization-Memberships-Code

Expire Date
primaryOrganization.memberships.expireDate string

PrimaryOrganization-Memberships-ExpireDate

Grace Expire Date
primaryOrganization.memberships.graceExpireDate string

PrimaryOrganization-Memberships-GraceExpireDate

Inherited Membership Benefits
primaryOrganization.memberships.inheritedMembershipBenefits boolean

PrimaryOrganization-Memberships-InheritedMembershipBenefits

Renewal Url
primaryOrganization.memberships.renewalUrl string

PrimaryOrganization-Memberships-RenewalUrl

Join Date
primaryOrganization.memberships.joinDate string

PrimaryOrganization-Memberships-JoinDate

Terminate Date
primaryOrganization.memberships.terminateDate string

PrimaryOrganization-Memberships-TerminateDate

Effective Date
primaryOrganization.memberships.effectiveDate string

PrimaryOrganization-Memberships-EffectiveDate

Category
primaryOrganization.category string

PrimaryOrganization-Category

categories
primaryOrganization.categories array of object
subCategories
primaryOrganization.categories.subCategories array of object

PrimaryOrganization-Categories-Subcategories

Code
primaryOrganization.categories.subCategories.code string

PrimaryOrganization-Categories-SubCategories-Code

Name
primaryOrganization.categories.subCategories.name string

PrimaryOrganization-Categories-SubCategories-Name

Code
primaryOrganization.categories.code string

PrimaryOrganization-Categories-Code

Name
primaryOrganization.categories.name string

PrimaryOrganization-Categories-Name

customFields
primaryOrganization.customFields array of object
Name
primaryOrganization.customFields.name string

PrimaryOrganization-CustomFields-Name

Caption
primaryOrganization.customFields.caption string

PrimaryOrganization-CustomFields-Caption

Value
primaryOrganization.customFields.value string

PrimaryOrganization-CustomFields-Value

Show In Directory
primaryOrganization.showInDirectory boolean

PrimaryOrganization-ShowInDirectory

links
primaryOrganization.links array of object
Type
primaryOrganization.links.type string

PrimaryOrganization-Links-Type

Url
primaryOrganization.links.url string

PrimaryOrganization-Links-Type

Old Id
primaryOrganization.oldId string

PrimaryOrganization-OldId

ContactIds
organizationRepresenting.contactIds array of uuid

OrganizationRepresenting-ContactIds

Parent Company Id
organizationRepresenting.parentCompanyId string

OrganizationRepresenting-ParentCompanyId

Description
organizationRepresenting.description string

OrganizationRepresenting-Description

Branch Name
organizationRepresenting.branchName string

OrganizationRepresenting-BranchName

Tags
organizationRepresenting.tags array of string

OrganizationRepresenting-Tags

Representing Organization Id
organizationRepresenting.id string

OrganizationRepresenting-OrganizationRepresentingId

Customer Type
organizationRepresenting.customerType string

OrganizationRepresenting-CustomerType

Record Number
organizationRepresenting.recordNumber string

OrganizationRepresenting-RecordNumber

Title
organizationRepresenting.title string

OrganizationRepresenting-Title

Name
organizationRepresenting.name string

OrganizationRepresenting-Name

addresses
organizationRepresenting.addresses array of object
Address Id
organizationRepresenting.addresses.id string

OrganizationRepresenting-Addresses-AddressId

Is Primary Address
organizationRepresenting.addresses.primary boolean

OrganizationRepresenting-Addresses-PrimaryAddress

Address Line 1
organizationRepresenting.addresses.line1 string

OrganizationRepresenting-Addresses-Line1

Address Line 2
organizationRepresenting.addresses.line2 string

OrganizationRepresenting-Addresses-Line2

Address Line 3
organizationRepresenting.addresses.line3 string

OrganizationRepresenting-Addresses-Line3

City
organizationRepresenting.addresses.city string

OrganizationRepresenting-Addresses-City

State
organizationRepresenting.addresses.state string

OrganizationRepresenting-Addresses-State

Zip Code
organizationRepresenting.addresses.zipcode string

OrganizationRepresenting-Addresses-ZipCode

Country
organizationRepresenting.addresses.country string

OrganizationRepresenting-Addresses-Country

State Abbreviation
organizationRepresenting.addresses.stateAbbreviation string

OrganizationRepresenting-Addresses-StateAbbreviation

State ISO Code
organizationRepresenting.addresses.stateISOCode string

OrganizationRepresenting-Addresses-StateISOCode

Type
organizationRepresenting.addresses.type string

OrganizationRepresenting-Addresses-Type

Region
organizationRepresenting.addresses.region string

OrganizationRepresenting-Addresses-Region

Latitude
organizationRepresenting.addresses.latitude number

OrganizationRepresenting-Addresses-Latitude

Longitude
organizationRepresenting.addresses.longitude number

OrganizationRepresenting-Addresses-Longitude

Show In Directory
organizationRepresenting.addresses.showInDirectory boolean

OrganizationRepresenting-Addresses-ShowInDirectory

Congressional District
organizationRepresenting.addresses.congressionalDistrict string

OrganizationRepresenting-Addresses-CongressionalDistrict

Country Id
organizationRepresenting.addresses.countryData.id string

OrganizationRepresenting-Addresses-Country-CountryId

Country Name
organizationRepresenting.addresses.countryData.name string

OrganizationRepresenting-Addresses-Country-CountryName

Two Letter ISO Code
organizationRepresenting.addresses.countryData.twoLetterIsoCode string

OrganizationRepresenting-Addresses-Country-TwoLetterIsoCode

Three Letter ISO Code
organizationRepresenting.addresses.countryData.threeLetterIsoCode string

OrganizationRepresenting-Addresses-Country-ThreeLetterIsoCode

Country Code
organizationRepresenting.addresses.countryData.code integer

OrganizationRepresenting-Addresses-Country-CountryCode

Email
organizationRepresenting.email string

OrganizationRepresenting-Email

Image Uri
organizationRepresenting.imageUri string

OrganizationRepresenting-ImageUri

Twitter
organizationRepresenting.twitter string

OrganizationRepresenting-Twitter

LinkedIn
organizationRepresenting.linkedIn string

OrganizationRepresenting-LinkedIn

emails
organizationRepresenting.emails array of object
Is Primary Email
organizationRepresenting.emails.primary boolean

OrganizationRepresenting-Emails-Primary

Address
organizationRepresenting.emails.address string

OrganizationRepresenting-Emails-Address

Type
organizationRepresenting.emails.type string

OrganizationRepresenting-Emails-Type

Show In Directory
organizationRepresenting.emails.showInDirectory boolean

OrganizationRepresenting-Emails-ShowInDirectory

phones
organizationRepresenting.phones array of object
Phone Id
organizationRepresenting.phones.id string

OrganizationRepresenting-Phones-Id

Is Primary Phone
organizationRepresenting.phones.primary boolean

OrganizationRepresenting-Phones-Primary

Type
organizationRepresenting.phones.type integer

OrganizationRepresenting-Phones-Type

Country Id
organizationRepresenting.phones.country.id string

OrganizationRepresenting-Phones-Country-CountryId

Country Name
organizationRepresenting.phones.country.name string

OrganizationRepresenting-Phones-Country-CountryName

Two Letter ISO Code
organizationRepresenting.phones.country.twoLetterIsoCode string

OrganizationRepresenting-Phones-Country-TwoLetterIsoCode

Three Letter ISO Code
organizationRepresenting.phones.country.threeLetterIsoCode string

OrganizationRepresenting-Phones-Country-ThreeLetterIsoCode

Country Code
organizationRepresenting.phones.country.code integer

OrganizationRepresenting-Phones-Country-CountryCode

Show In Directory
organizationRepresenting.phones.showInDirectory boolean

OrganizationRepresenting-Phones-ShowInDirectory

Number
organizationRepresenting.phones.number string

OrganizationRepresenting-Phones-Number

Extension
organizationRepresenting.phones.extension string

OrganizationRepresenting-Phones-Extension

Type Name
organizationRepresenting.phones.typeName string

OrganizationRepresenting-Phones-TypeName

WebSite
organizationRepresenting.webSite string

OrganizationRepresenting-WebSite

memberships
organizationRepresenting.memberships array of object
Membership Type
organizationRepresenting.memberships.membershipType string

OrganizationRepresenting-Memberships-MembershipType

Membership Type Id
organizationRepresenting.memberships.membershipTypeId string

OrganizationRepresenting-Memberships-MembershipTypeId

Code
organizationRepresenting.memberships.code string

OrganizationRepresenting-Memberships-Code

Expire Date
organizationRepresenting.memberships.expireDate string

OrganizationRepresenting-Memberships-ExpireDate

Grace Expire Date
organizationRepresenting.memberships.graceExpireDate string

OrganizationRepresenting-Memberships-GraceExpireDate

Inherited Membership Benefits
organizationRepresenting.memberships.inheritedMembershipBenefits boolean

OrganizationRepresenting-Memberships-InheritedMembershipBenefits

Renewal Url
organizationRepresenting.memberships.renewalUrl string

OrganizationRepresenting-Memberships-RenewalUrl

Join Date
organizationRepresenting.memberships.joinDate string

OrganizationRepresenting-Memberships-JoinDate

Terminate Date
organizationRepresenting.memberships.terminateDate string

OrganizationRepresenting-Memberships-TerminateDate

Effective Date
organizationRepresenting.memberships.effectiveDate string

OrganizationRepresenting-Memberships-EffectiveDate

Category
organizationRepresenting.category string

OrganizationRepresenting-Category

categories
organizationRepresenting.categories array of object

OrganizationRepresenting-Categories

subCategories
organizationRepresenting.categories.subCategories array of object

OrganizationRepresenting-Categories-Subcategories

Code
organizationRepresenting.categories.subCategories.code string

OrganizationRepresenting-Categories-SubCategories-Code

Name
organizationRepresenting.categories.subCategories.name string

OrganizationRepresenting-Categories-SubCategories-Name

Code
organizationRepresenting.categories.code string

OrganizationRepresenting-Categories-Code

Name
organizationRepresenting.categories.name string

OrganizationRepresenting-Categories-Name

customFields
organizationRepresenting.customFields array of object
Name
organizationRepresenting.customFields.name string

OrganizationRepresenting-CustomFields-Name

Caption
organizationRepresenting.customFields.caption string

OrganizationRepresenting-CustomFields-Caption

Value
organizationRepresenting.customFields.value string

OrganizationRepresenting-CustomFields-Value

Show In Directory
organizationRepresenting.showInDirectory boolean

OrganizationRepresenting-ShowInDirectory

links
organizationRepresenting.links array of object
Type
organizationRepresenting.links.type string

OrganizationRepresenting-Links-Type

Url
organizationRepresenting.links.url string

OrganizationRepresenting-Links-Type

Old Id
organizationRepresenting.oldId string

OrganizationRepresenting-OldId

Nominated By Customer Id
nominatedByCustomer.id string

NominatedByCustomer-NominatedByCustomerId

Customer Type
nominatedByCustomer.customerType string

NominatedByCustomer-CustomerType

Record Number
nominatedByCustomer.recordNumber string

NominatedByCustomer-RecordNumber

Title
nominatedByCustomer.title string

NominatedByCustomer-Title

Name
nominatedByCustomer.name string

NominatedByCustomer-Name

addresses
nominatedByCustomer.addresses array of object
Address Id
nominatedByCustomer.addresses.id string

NominatedByCustomer-Addresses-AddressId

Is Primary Address
nominatedByCustomer.addresses.primary boolean

NominatedByCustomer-Addresses-PrimaryAddress

Address Line 1
nominatedByCustomer.addresses.line1 string

NominatedByCustomer-Addresses-Line1

Address Line 2
nominatedByCustomer.addresses.line2 string

NominatedByCustomer-Addresses-Line2

Address Line 3
nominatedByCustomer.addresses.line3 string

NominatedByCustomer-Addresses-Line3

City
nominatedByCustomer.addresses.city string

NominatedByCustomer-Addresses-City

State
nominatedByCustomer.addresses.state string

NominatedByCustomer-Addresses-State

Zip Code
nominatedByCustomer.addresses.zipcode string

NominatedByCustomer-Addresses-ZipCode

Country
nominatedByCustomer.addresses.country string

NominatedByCustomer-Addresses-Country

State Abbreviation
nominatedByCustomer.addresses.stateAbbreviation string

NominatedByCustomer-Addresses-StateAbbreviation

State ISO Code
nominatedByCustomer.addresses.stateISOCode string

NominatedByCustomer-Addresses-StateISOCode

Type
nominatedByCustomer.addresses.type string

NominatedByCustomer-Addresses-Type

Region
nominatedByCustomer.addresses.region string

NominatedByCustomer-Addresses-Region

Latitude
nominatedByCustomer.addresses.latitude number

NominatedByCustomer-Addresses-Latitude

Longitude
nominatedByCustomer.addresses.longitude number

NominatedByCustomer-Addresses-Longitude

Show In Directory
nominatedByCustomer.addresses.showInDirectory boolean

NominatedByCustomer-Addresses-ShowInDirectory

Congressional District
nominatedByCustomer.addresses.congressionalDistrict string

NominatedByCustomer-Addresses-CongressionalDistrict

Country Id
nominatedByCustomer.addresses.countryData.id string

NominatedByCustomer-Addresses-Country-CountryId

Country Name
nominatedByCustomer.addresses.countryData.name string

NominatedByCustomer-Addresses-Country-CountryName

Two Letter ISO Code
nominatedByCustomer.addresses.countryData.twoLetterIsoCode string

NominatedByCustomer-Addresses-Country-TwoLetterIsoCode

Three Letter ISO Code
nominatedByCustomer.addresses.countryData.threeLetterIsoCode string

NominatedByCustomer-Addresses-Country-ThreeLetterIsoCode

Country Code
nominatedByCustomer.addresses.countryData.code integer

NominatedByCustomer-Addresses-Country-CountryCode

Email
nominatedByCustomer.email string

NominatedByCustomer-Email

Image Uri
nominatedByCustomer.imageUri string

NominatedByCustomer-ImageUri

Twitter
nominatedByCustomer.twitter string

NominatedByCustomer-Twitter

LinkedIn
nominatedByCustomer.linkedIn string

NominatedByCustomer-LinkedIn

emails
nominatedByCustomer.emails array of object
Is Primary Email
nominatedByCustomer.emails.primary boolean

NominatedByCustomer-Emails-Primary

Address
nominatedByCustomer.emails.address string

NominatedByCustomer-Emails-Address

Type
nominatedByCustomer.emails.type string

NominatedByCustomer-Emails-Type

Show In Directory
nominatedByCustomer.emails.showInDirectory boolean

NominatedByCustomer-Emails-ShowInDirectory

phones
nominatedByCustomer.phones array of object
Phone Id
nominatedByCustomer.phones.id string

NominatedByCustomer-Phones-Id

Is Primary Phone
nominatedByCustomer.phones.primary boolean

NominatedByCustomer-Phones-Primary

Type
nominatedByCustomer.phones.type integer

NominatedByCustomer-Phones-Type

Country Id
nominatedByCustomer.phones.country.id string

NominatedByCustomer-Phones-Country-CountryId

Country Name
nominatedByCustomer.phones.country.name string

NominatedByCustomer-Phones-Country-CountryName

Two Letter ISO Code
nominatedByCustomer.phones.country.twoLetterIsoCode string

NominatedByCustomer-Phones-Country-TwoLetterIsoCode

Three Letter ISO Code
nominatedByCustomer.phones.country.threeLetterIsoCode string

NominatedByCustomer-Phones-Country-ThreeLetterIsoCode

Country Code
nominatedByCustomer.phones.country.code integer

NominatedByCustomer-Phones-Country-CountryCode

Show In Directory
nominatedByCustomer.phones.showInDirectory boolean

NominatedByCustomer-Phones-ShowInDirectory

Number
nominatedByCustomer.phones.number string

NominatedByCustomer-Phones-Number

Extension
nominatedByCustomer.phones.extension string

NominatedByCustomer-Phones-Extension

Type Name
nominatedByCustomer.phones.typeName string

NominatedByCustomer-Phones-TypeName

WebSite
nominatedByCustomer.webSite string

NominatedByCustomer-WebSite

memberships
nominatedByCustomer.memberships array of object
Membership Type
nominatedByCustomer.memberships.membershipType string

NominatedByCustomer-Memberships-MembershipType

Membership Type Id
nominatedByCustomer.memberships.membershipTypeId string

NominatedByCustomer-Memberships-MembershipTypeId

Code
nominatedByCustomer.memberships.code string

NominatedByCustomer-Memberships-Code

Expire Date
nominatedByCustomer.memberships.expireDate string

NominatedByCustomer-Memberships-ExpireDate

Grace Expire Date
nominatedByCustomer.memberships.graceExpireDate string

NominatedByCustomer-Memberships-GraceExpireDate

Inherited Membership Benefits
nominatedByCustomer.memberships.inheritedMembershipBenefits boolean

NominatedByCustomer-Memberships-InheritedMembershipBenefits

Renewal Url
nominatedByCustomer.memberships.renewalUrl string

NominatedByCustomer-Memberships-RenewalUrl

Join Date
nominatedByCustomer.memberships.joinDate string

NominatedByCustomer-Memberships-JoinDate

Terminate Date
nominatedByCustomer.memberships.terminateDate string

NominatedByCustomer-Memberships-TerminateDate

Effective Date
nominatedByCustomer.memberships.effectiveDate string

NominatedByCustomer-Memberships-EffectiveDate

Category
nominatedByCustomer.category string

NominatedByCustomer-Category

categories
nominatedByCustomer.categories array of object

NominatedByCustomer-Categories

subCategories
nominatedByCustomer.categories.subCategories array of object

NominatedByCustomer-Categories-SubCategories

Code
nominatedByCustomer.categories.subCategories.code string

NominatedByCustomer-Categories-SubCategories-Code

Name
nominatedByCustomer.categories.subCategories.name string

NominatedByCustomer-Categories-SubCategories-Name

Code
nominatedByCustomer.categories.code string

NominatedByCustomer-Categories-Code

Name
nominatedByCustomer.categories.name string

NominatedByCustomer-Categories-Name

customFields
nominatedByCustomer.customFields array of object
Name
nominatedByCustomer.customFields.name string

NominatedByCustomer-CustomFields-Name

Caption
nominatedByCustomer.customFields.caption string

NominatedByCustomer-CustomFields-Caption

Value
nominatedByCustomer.customFields.value string

NominatedByCustomer-CustomFields-Value

Show In Directory
nominatedByCustomer.showInDirectory boolean

NominatedByCustomer-ShowInDirectory

links
nominatedByCustomer.links array of object
Type
nominatedByCustomer.links.type string

NominatedByCustomer-Links-Type

Url
nominatedByCustomer.links.url string

NominatedByCustomer-Links-Type

Old Id
nominatedByCustomer.oldId string

NominatedByCustomer-OldId

addresses
addresses array of object
Address Id
addresses.id string

Addresses-AddressId

Is Primary Address
addresses.primary boolean

Addresses-PrimaryAddress

Address Line 1
addresses.line1 string

Addresses-Line1

Address Line 2
addresses.line2 string

Addresses-Line2

Address Line 3
addresses.line3 string

Addresses-Line3

City
addresses.city string

Addresses-City

State
addresses.state string

Addresses-State

Zip Code
addresses.zipcode string

Addresses-ZipCode

Country
addresses.country string

Addresses-Country

State Abbreviation
addresses.stateAbbreviation string

Addresses-StateAbbreviation

State ISO Code
addresses.stateISOCode string

Addresses-StateISOCode

Type
addresses.type string

Addresses-Type

Region
addresses.region string

Addresses-Region

Latitude
addresses.latitude number

Addresses-Latitude

Longitude
addresses.longitude number

Addresses-Longitude

Show In Directory
addresses.showInDirectory boolean

Addresses-ShowInDirectory

Congressional District
addresses.congressionalDistrict string

Addresses-CongressionalDistrict

Country Id
addresses.countryData.id string

Addresses-Country-CountryId

Country Name
addresses.countryData.name string

Addresses-Country-CountryName

Two Letter ISO Code
addresses.countryData.twoLetterIsoCode string

Addresses-Country-TwoLetterIsoCode

Three Letter ISO Code
addresses.countryData.threeLetterIsoCode string

Addresses-Country-ThreeLetterIsoCode

Country Code
addresses.countryData.code integer

Addresses-Country-CountryCode

phones
phones array of object
Phone Id
phones.id string

Phones-Id

Is Primary Phone
phones.primary boolean

Phones-Primary

Type
phones.type integer

Phones-Type

Country Id
phones.country.id string

Phones-Country-CountryId

Country Name
phones.country.name string

Phones-Country-CountryName

Two Letter ISO Code
phones.country.twoLetterIsoCode string

Phones-Country-TwoLetterIsoCode

Three Letter ISO Code
phones.country.threeLetterIsoCode string

Phones-Country-ThreeLetterIsoCode

Country Code
phones.country.code integer

Phones-Country-CountryCode

Show In Directory
phones.showInDirectory boolean

Phones-ShowInDirectory

Number
phones.number string

Phones-Number

Extension
phones.extension string

Phones-Extension

Type Name
phones.typeName string

Phones-TypeName

emails
emails array of object
Is Primary Email
emails.primary boolean

Emails-Primary

Address
emails.address string

Emails-Address

Type
emails.type string

Emails-Type

Show In Directory
emails.showInDirectory boolean

Emails-ShowInDirectory

Rank
rank integer

Rank

Add Organization

Add Organization

Parameters

Name Key Required Type Description
Name
name True string

Name

Branch Name
branchName string

Branch Name

Website
website string

Website

Returns

OrganizationData

Add Relationship to Individual

Add Relationship to Individual

Parameters

Name Key Required Type Description
Individual ID
id True string

Individual ID

Relationship Name
relationshipName True string

relationshipName

Related To Customer Record Number
relatedToCustomerRecordNumber True string

Related To Customer Record Number

Reciprocal Relationship Name
reciprocalRelationshipName True string

reciprocalRelationshipName

Is Primary?
isPrimary boolean

isPrimary

Start Date
startDate string

Start Date

End Date
endDate string

End Date

Returns

Find Customer by Phone Number

Find Customer by Phone Number

Parameters

Name Key Required Type Description
Phone Number
phoneNumber True string

Phone Number

Returns

Name Path Type Description
Page Number
pageNumber integer

PageNumber

dataList
dataList array of object
Full Name
dataList.fullName string

FullName

Customer Id
dataList.id string

CustomerId

Customer Type
dataList.customerType string

CustomerType

Record Number
dataList.recordNumber string

RecordNumber

Show In Directory
dataList.showInDirectory boolean

ShowInDirectory

addresses
dataList.addresses array of object
Address Id
dataList.addresses.id string

AddressesAddressId

Is Primary Address
dataList.addresses.primary boolean

Addresses-PrimaryAddress

Address Line 1
dataList.addresses.line1 string

Addresses-Line1

Address Line 2
dataList.addresses.line2 string

Addresses-Line2

Address Line 3
dataList.addresses.line3 string

Addresses-Line3

City
dataList.addresses.city string

Addresses-City

State
dataList.addresses.state string

Addresses-State

Zip Code
dataList.addresses.zipcode string

Addresses-ZipCode

Country
dataList.addresses.country string

Addresses-Country

State Abbreviation
dataList.addresses.stateAbbreviation string

Addresses-StateAbbreviation

State ISO Code
dataList.addresses.stateISOCode string

Addresses-StateISOCode

Type
dataList.addresses.type string

Addresses-Type

Region
dataList.addresses.region string

Addresses-Region

Latitude
dataList.addresses.latitude number

Addresses-Latitude

Longitude
dataList.addresses.longitude number

Addresses-Longitude

Show In Directory
dataList.addresses.showInDirectory boolean

Addresses-ShowInDirectory

Congressional District
dataList.addresses.congressionalDistrict string

Addresses-CongressionalDistrict

Country Id
dataList.addresses.countryData.id string

Addresses-Country-CountryId

Country Name
dataList.addresses.countryData.name string

Addresses-Country-CountryName

Two Letter ISO Code
dataList.addresses.countryData.twoLetterIsoCode string

Addresses-Country-TwoLetterIsoCode

Three Letter ISO Code
dataList.addresses.countryData.threeLetterIsoCode string

Addresses-Country-ThreeLetterIsoCode

Country Code
dataList.addresses.countryData.code integer

Addresses-Country-CountryCode

emails
dataList.emails array of object
Is Primary Email
dataList.emails.primary boolean

Emails-Primary

Address
dataList.emails.address string

Emails-Address

Type
dataList.emails.type string

Emails-Type

Show In Directory
dataList.emails.showInDirectory boolean

Emails-ShowInDirectory

phones
dataList.phones array of object
Phone Id
dataList.phones.id string

Phones-Id

Is Primary Phone
dataList.phones.primary boolean

Phones-Primary

Type
dataList.phones.type integer

Phones-Type

Country Id
dataList.phones.country.id string

Phones-Country-CountryId

Country Name
dataList.phones.country.name string

Phones-Country-CountryName

Two Letter ISO Code
dataList.phones.country.twoLetterIsoCode string

Phones-Country-TwoLetterIsoCode

Three Letter ISO Code
dataList.phones.country.threeLetterIsoCode string

Phones-Country-ThreeLetterIsoCode

Country Code
dataList.phones.country.code integer

Phones-Country-CountryCode

Show In Directory
dataList.phones.showInDirectory boolean

Phones-ShowInDirectory

Number
dataList.phones.number string

Phones-Number

Extension
dataList.phones.extension string

Phones-Extension

Type Name
dataList.phones.typeName string

Phones-TypeName

Find Individual by ID or Email or Record Number

Find Individual by ID or Email

Parameters

Name Key Required Type Description
ID Or Record Number Or Email
idOrRecordNumberOrEmail True string

ID Or Record Number Or Email

Returns

Name Path Type Description
pageNumber
pageNumber integer

Page Number

dataList
dataList array of IndividualData

Data List

Update Custom Field Value

Update Custom Field Value

Parameters

Name Key Required Type Description
Customer ID
id True string

Customer ID

Custom Field Name
name True string

Custom Field Name

Custom Field Value
value True string

Custom Field Value. For multi-selects, use "|" as delimiter

Returns

Update Organization

Update Organization

Parameters

Name Key Required Type Description
Organization ID
id True string

Organization ID

Name
name string

Name

Description
description string

Description

Show In Directory
showInDirectory boolean

Show In Directory

Branch Name
branchName string

Branch Name

Website
website string

Website

Returns

OrganizationData

Triggers

Individual Created

When an Individual is created

When Product is Purchased

When Product is Purchased. Supported Product Types: Merchandise, Courses, Exams

Individual Created

When an Individual is created

Returns

Individual Payload

When Product is Purchased

When Product is Purchased. Supported Product Types: Merchandise, Courses, Exams

Parameters

Name Key Required Type Description
Product Code
filters string

This triggers when a product is purchased

Returns

Name Path Type Description
Webhook Id
WebhookId string

WebhookId

Additional Filter
Properties.AdditionalFilter string

AdditionalFilter

Date
Properties.Date string

Date

Notifications
Notifications array of object

Notifications

Action
Notifications.Action string

Action

Order Number
Notifications.OrderNumber string

OrderNumber

Invoice Number
Notifications.InvoiceNumber string

InvoiceNumber

Product Code
Notifications.ProductCode string

ProductCode

Product Name
Notifications.ProductName string

ProductName

Product Type
Notifications.ProductType string

ProductType

Quantity
Notifications.Quantity integer

Quantity

Item Price
Notifications.ItemPrice double

ItemPrice

Customer Type
Notifications.CustomerType string

CustomerType

Customer Id
Notifications.CustomerId string

CustomerId

Full Name
Notifications.FullName string

FullName

First Name
Notifications.FirstName string

FirstName

Last Name
Notifications.LastName string

LastName

Email Address
Notifications.EmailAddress string

EmailAddress

Record Number
Notifications.RecordNumber string

RecordNumber

Definitions

IndividualData

Name Path Type Description
First Name
firstName string

FirstName

Last Name
lastName string

LastName

Middle Name
middleName string

MiddleName

Preferred First Name
preferredFirstName string

PreferredFirstName

Second Last Name
secondLastName string

SecondLastName

Prefix
prefix string

Prefix

Suffix
suffix string

Suffix

Gender
gender string

Gender

ContactIds
primaryOrganization.contactIds array of uuid

PrimaryOrganization-ContactIds

Parent Company Id
primaryOrganization.parentCompanyId uuid

PrimaryOrganization-ParentCompanyId

Description
primaryOrganization.description string

PrimaryOrganization-Description

Branch Name
primaryOrganization.branchName string

PrimaryOrganization-BranchName

Tags
primaryOrganization.tags array of string

PrimaryOrganization-Tags

Primary Organization Id
primaryOrganization.id uuid

PrimaryOrganizationId

CustomerType
primaryOrganization.customerType string

PrimaryOrganization-CustomerType

Record Number
primaryOrganization.recordNumber string

PrimaryOrganization-RecordNumber

Title
primaryOrganization.title string

PrimaryOrganization-Title

Name
primaryOrganization.name string

PrimaryOrganization-Name

addresses
primaryOrganization.addresses array of object

PrimaryOrganization-Addresses

Address Id
primaryOrganization.addresses.id uuid

PrimaryOrganization-Addresses-Id

Is Primary Address
primaryOrganization.addresses.primary boolean

PrimaryOrganization-Addresses-IsPrimary

Address Line 1
primaryOrganization.addresses.line1 string

PrimaryOrganization-Addresses-Line1

Address Line 2
primaryOrganization.addresses.line2 string

PrimaryOrganization-Addresses-Line2

Address Line 3
primaryOrganization.addresses.line3 string

PrimaryOrganization-Addresses-Line3

City
primaryOrganization.addresses.city string

PrimaryOrganization-Addresses-City

State
primaryOrganization.addresses.state string

PrimaryOrganization-Addresses-State

Zip Code
primaryOrganization.addresses.zipcode string

PrimaryOrganization-Addresses-ZipCode

Country
primaryOrganization.addresses.country string

PrimaryOrganization-Addresses-Country

State Abbreviation
primaryOrganization.addresses.stateAbbreviation string

PrimaryOrganization-Addresses-StateAbbreviation

State ISO Code
primaryOrganization.addresses.stateISOCode string

PrimaryOrganization-Addresses-StateISOCode

Type
primaryOrganization.addresses.type string

PrimaryOrganization-Addresses-Type

Region
primaryOrganization.addresses.region string

PrimaryOrganization-Addresses-Region

Latitude
primaryOrganization.addresses.latitude number

PrimaryOrganization-Addresses-Latitude

Longitude
primaryOrganization.addresses.longitude number

PrimaryOrganization-Addresses-Longitude

Show In Directory
primaryOrganization.addresses.showInDirectory boolean

PrimaryOrganization-Addresses-ShowInDirectory

Congressional District
primaryOrganization.addresses.congressionalDistrict string

PrimaryOrganization-Addresses-CongressionalDistrict

Country Id
primaryOrganization.addresses.countryData.id string

PrimaryOrganization-Addresses-Country-Id

Country Name
primaryOrganization.addresses.countryData.name string

PrimaryOrganization-Addresses-Country-Name

Two Letter ISO Code
primaryOrganization.addresses.countryData.twoLetterIsoCode string

PrimaryOrganization-Addresses-Country-TwoLetterIsoCode

Three Letter ISO Code
primaryOrganization.addresses.countryData.threeLetterIsoCode string

PrimaryOrganization-Addresses-Country-ThreeLetterIsoCode

Country Code
primaryOrganization.addresses.countryData.code integer

PrimaryOrganization-Addresses-Country-Code

Email
primaryOrganization.email email

PrimaryOrganization-Email

Image Uri
primaryOrganization.imageUri uri

PrimaryOrganization-ImageUri

Twitter
primaryOrganization.twitter uri

PrimaryOrganization-Twitter

LinkedIn
primaryOrganization.linkedIn uri

PrimaryOrganization-LinkedIn

emails
primaryOrganization.emails array of object

PrimaryOrganization-Emails

Is Primary Email
primaryOrganization.emails.primary boolean

PrimaryOrganization-Emails-IsPrimary

Address
primaryOrganization.emails.address string

PrimaryOrganization-Emails-Address

Type
primaryOrganization.emails.type string

PrimaryOrganization-Emails-Type

Show In Directory
primaryOrganization.emails.showInDirectory boolean

PrimaryOrganization-Emails-ShowInDirectory

phones
primaryOrganization.phones array of object

PrimaryOrganization-Phones

Phone Id
primaryOrganization.phones.id uuid

PrimaryOrganization-Phones-Id

Is Primary Phone
primaryOrganization.phones.primary boolean

PrimaryOrganization-Phones-IsPrimary

Type
primaryOrganization.phones.type integer

PrimaryOrganization-Phones-Type

Country Id
primaryOrganization.phones.country.id uuid

PrimaryOrganization-Phones-Country-Id

Country Name
primaryOrganization.phones.country.name string

PrimaryOrganization-Phones-Country-Name

Two Letter ISO Code
primaryOrganization.phones.country.twoLetterIsoCode string

PrimaryOrganization-Phones-Country-TwoLetterIsoCode

Three Letter ISO Code
primaryOrganization.phones.country.threeLetterIsoCode string

PrimaryOrganization-Phones-Country-ThreeLetterIsoCode

Country Code
primaryOrganization.phones.country.code integer

PrimaryOrganization-Phones-Country-Code

Show In Directory
primaryOrganization.phones.showInDirectory boolean

PrimaryOrganization-Phones-ShowInDirectory

Phone Number
primaryOrganization.phones.number string

PrimaryOrganization-Phones-Number

Extension
primaryOrganization.phones.extension string

PrimaryOrganization-Phones-Extension

Type Name
primaryOrganization.phones.typeName string

PrimaryOrganization-Phones-TypeName

WebSite
primaryOrganization.webSite uri

PrimaryOrganization-WebSite

memberships
primaryOrganization.memberships array of object

PrimaryOrganization-Memberships

Membership Type
primaryOrganization.memberships.membershipType string

PrimaryOrganization-Memberships-MembershipType

Membership Type Id
primaryOrganization.memberships.membershipTypeId uuid

PrimaryOrganization-Memberships-MembershipTypeId

Code
primaryOrganization.memberships.code string

PrimaryOrganization-Memberships-Code

Expire Date
primaryOrganization.memberships.expireDate date-time

PrimaryOrganization-Memberships-ExpireDate

Grace Expire Date
primaryOrganization.memberships.graceExpireDate date-time

PrimaryOrganization-Memberships-GraceExpireDate

Inherited Membership Benefits
primaryOrganization.memberships.inheritedMembershipBenefits boolean

PrimaryOrganization-Memberships-InheritedMembershipBenefits

Renewal Url
primaryOrganization.memberships.renewalUrl string

PrimaryOrganization-Memberships-RenewalUrl

Join Date
primaryOrganization.memberships.joinDate date-time

PrimaryOrganization-Memberships-JoinDate

Terminate Date
primaryOrganization.memberships.terminateDate date-time

PrimaryOrganization-Memberships-TerminateDate

Effective Date
primaryOrganization.memberships.effectiveDate date-time

PrimaryOrganization-Memberships-EffectiveDate

Category
primaryOrganization.category string

PrimaryOrganization-Category

categories
primaryOrganization.categories array of object

PrimaryOrganization-Categories

subCategories
primaryOrganization.categories.subCategories array of object

PrimaryOrganization-Categories-Subcategories

Code
primaryOrganization.categories.subCategories.code string

PrimaryOrganization-Categories-SubCategories-Code

Name
primaryOrganization.categories.subCategories.name string

PrimaryOrganization-Categories-SubCategories-Name

Code
primaryOrganization.categories.code string

PrimaryOrganization-Categories-Code

Name
primaryOrganization.categories.name string

PrimaryOrganization-Categories-Name

customFields
primaryOrganization.customFields array of object

PrimaryOrganization-CustomFields

Name
primaryOrganization.customFields.name string

PrimaryOrganization-CustomFields-Name

Caption
primaryOrganization.customFields.caption string

PrimaryOrganization-CustomFields-Caption

Value
primaryOrganization.customFields.value string

PrimaryOrganization-CustomFields-Value

Show In Directory
primaryOrganization.showInDirectory boolean

PrimaryOrganization-ShowInDirectory

links
primaryOrganization.links array of object

PrimaryOrganization-Links

Type
primaryOrganization.links.type string

PrimaryOrganization-Links-Type

Url
primaryOrganization.links.url uri

PrimaryOrganization-Links-Url

Old Id
primaryOrganization.oldId string

PrimaryOrganization-OldId

committees
committees array of object

Committees

Name
committees.committee.name string

Committees-Committee-Name

Code
committees.committee.code string

Committees-Committee-Code

Website
committees.committee.website string

Committees-Committee-Website

Id
committees.committee.id uuid

Committees-Committee-Id

Parent Committee Id
committees.committee.parentCommitteeId uuid

Committees-Committee-ParentCommitteeId

Category Name
committees.committee.categoryName string

Committees-Committee-CategoryName

Category Code
committees.committee.categoryCode string

Committees-Committee-CategoryCode

Description
committees.committee.description string

Committees-Committee-Description

Start Date
committees.committee.startDate date-time

Committees-Committee-StartDate

Committee End Date
committees.committee.endDate date-time

Committees-Committee-EndDate

Show In Directory
committees.committee.showInDirectory boolean

Committees-Committee-ShowInDirectory

Term
committees.committee.term.term integer

Committees-Committee-Term-Term

Start Date
committees.committee.term.startDate date-time

Committees-Committee-Term-StartDate

End Date
committees.committee.term.endDate date-time

Committees-Committee-Term-EndDate

Show In Directory
committees.committee.term.showInDirectory boolean

Committees-Committee-Term-ShowInDirectory

Tags
committees.committee.tags array of string

Committees-Committee-Tags

Position
committees.position string

Committees-Position

Position Code
committees.positionCode string

Committees-PositionCode

Code
committees.code string

Committees-Code

Start Date
committees.startDate date-time

Committees-StartDate

End Date
committees.endDate date-time

Committees-EndDate

securityRoles
securityRoles array of object

SecurityRoles

Name
securityRoles.name string

SecurityRoles-Name

Login Email
user.loginEmail string

User-LoginEmail

Must Change Password
user.mustChangePassword boolean

User-MustChangePassword

Is Approved
user.isApproved boolean

User-IsApproved

designationData
designationData array of object

Designations

Name
designationData.name string

Designations-Name

jobRoles
jobRoles array of object

JobRoles

Code
jobRoles.code string

JobRoles-Code

Name
jobRoles.name string

JobRoles-name

Tags
tags array of string

Tags

Individual Id
id uuid

IndividualId

Customer Type
customerType string

CustomerType

Record Number
recordNumber string

RecordNumber

Title
title string

Title

Name
name string

Name

addresses
addresses array of object

Addresses

Address Id
addresses.id uuid

Addresses-Id

Is Primary Address
addresses.primary boolean

Addresses-IsPrimary

Address Line 1
addresses.line1 string

Addresses-Line1

Address Line 2
addresses.line2 string

Addresses-Line2

Address Line 3
addresses.line3 string

Addresses-Line3

City
addresses.city string

Addresses-City

State
addresses.state string

Addresses-State

Zip Code
addresses.zipcode string

Addresses-ZipCode

Country
addresses.country string

Addresses-Country

State Abbreviation
addresses.stateAbbreviation string

Addresses-StateAbbreviation

State ISO Code
addresses.stateISOCode string

Addresses-StateISOCode

Type
addresses.type string

Addresses-Type

Region
addresses.region string

Addresses-Region

Latitude
addresses.latitude number

Addresses-Latitude

Longitude
addresses.longitude number

Addresses-Longitude

Show In Directory
addresses.showInDirectory boolean

Addresses-ShowInDirectory

Congressional District
addresses.congressionalDistrict string

Addresses-CongressionalDistrict

Country Id
addresses.countryData.id uuid

Addresses-Country-Id

Country Name
addresses.countryData.name string

Addresses-Country-Name

Two Letter ISO Code
addresses.countryData.twoLetterIsoCode string

Addresses-Country-TwoLetterIsoCode

Three Letter ISO Code
addresses.countryData.threeLetterIsoCode string

Addresses-Country-ThreeLetterIsoCode

Country Code
addresses.countryData.code integer

Addresses-Country-Code

Email
email email

Email

Image Uri
imageUri uri

ImageUri

Twitter
twitter uri

Twitter

LinkedIn
linkedIn uri

LinkedIn

emails
emails array of object

Emails

Is Primary Email
emails.primary boolean

Emails-IsPrimary

Address
emails.address string

Emails-Address

Type
emails.type string

Emails-Type

Show In Directory
emails.showInDirectory boolean

Emails-ShowInDirectory

phones
phones array of object

Phones

Phone Id
phones.id string

Phones-Id

Is Primary Phone
phones.primary boolean

Phones-IsPrimary

Type
phones.type integer

Phones-Type

Country Id
phones.country.id string

Phones-Country-Id

Country Name
phones.country.name string

Phones-Country-Name

Two Letter ISO Code
phones.country.twoLetterIsoCode string

Phones-Country-TwoLetterIsoCode

Three Letter ISO Code
phones.country.threeLetterIsoCode string

Phones-Country-ThreeLetterIsoCode

Country Code
phones.country.code integer

Phones-Country-Code

Show In Directory
phones.showInDirectory boolean

Phones-ShowInDirectory

Number
phones.number string

Phones-Number

Extension
phones.extension string

Phones-Extension

Type Name
phones.typeName string

Phones-TypeName

WebSite
webSite uri

WebSite

memberships
memberships array of object

Memberships

Membership Type
memberships.membershipType string

Memberships-MembershipType

Membership Type Id
memberships.membershipTypeId string

Memberships-MembershipTypeId

Code
memberships.code string

Memberships-Code

Expire Date
memberships.expireDate date-time

Memberships-ExpireDate

Grace Expire Date
memberships.graceExpireDate date-time

Memberships-GraceExpireDate

Inherited Membership Benefits
memberships.inheritedMembershipBenefits boolean

Memberships-InheritedMembershipBenefits

Renewal Url
memberships.renewalUrl string

Memberships-RenewalUrl

Join Date
memberships.joinDate date-time

Memberships-JoinDate

Terminate Date
memberships.terminateDate date-time

Memberships-TerminateDate

Effective Date
memberships.effectiveDate date-time

Memberships-EffectiveDate

Category
category string

Category

categories
categories array of object

Categories

subCategories
categories.subCategories array of object

Categories-Subcategories

Code
categories.subCategories.code string

Categories-SubCategories-Code

Name
categories.subCategories.name string

Categories-SubCategories-Name

Code
categories.code string

Categories-Code

Name
categories.name string

Categories-Name

customFields
customFields array of object

CustomFields

Name
customFields.name string

CustomFields-Name

Caption
customFields.caption string

CustomFields-Caption

Value
customFields.value string

CustomFields-Value

Show In Directory
showInDirectory boolean

ShowInDirectory

links
links array of object

Links

Type
links.type string

Links-Type

Url
links.url string

Links-Url

Old Id
oldId string

OldId

Is Deceased
isDeceased boolean

IsDeceased

IndividualPayload

Individual Payload

Name Path Type Description
Webhook Id
WebhookId uuid

WebhookId

Date
Properties.Date date-time

Properties-Date

Notifications
Notifications array of object

Notifications

Action
Notifications.Action string

Notifications-Action

Individual Id
Notifications.IndividualId uuid

Notifications-IndividualId

Record Number
Notifications.RecordNumber string

Notifications-RecordNumber

First Name
Notifications.FirstName string

Notifications-FirstName

Last Name
Notifications.LastName string

Notifications-LastName

Email Address
Notifications.EmailAddress email

Notifications-EmailAddress

OrganizationData

OrganizationData

Name Path Type Description
Page Number
pageNumber integer

PageNumber

dataList
dataList array of object

DataList

contactIds
dataList.contactIds array of string

ContactIds

Parent Company Id
dataList.parentCompanyId uuid

ParentCompanyId

Description
dataList.description string

Description

Branch Name
dataList.branchName string

BranchName

tags
dataList.tags array of string

Tags

Organization Id
dataList.id uuid

OrganizationId

Customer Type
dataList.customerType string

CustomerType

Record Number
dataList.recordNumber string

RecordNumber

Title
dataList.title string

Title

Organization Name
dataList.name string

OrganizationName

addresses
dataList.addresses array of object

Addresses

Address Id
dataList.addresses.id uuid

Addresses-AddressId

Is Primary Address
dataList.addresses.primary boolean

Addresses-IsPrimary

Address Line 1
dataList.addresses.line1 string

Addresses-Line1

Address Line 2
dataList.addresses.line2 string

Addresses-Line2

Address Line 3
dataList.addresses.line3 string

Addresses-Line3

City
dataList.addresses.city string

Addresses-City

State
dataList.addresses.state string

Addresses-State

Zip Code
dataList.addresses.zipcode string

Addresses-ZipCode

Country
dataList.addresses.country string

Addresses-Country

State Abbreviation
dataList.addresses.stateAbbreviation string

Addresses-StateAbbreviation

State ISO Code
dataList.addresses.stateISOCode string

Addresses-StateISOCode

Type
dataList.addresses.type string

Addresses-Type

Region
dataList.addresses.region string

Addresses-Region

Latitude
dataList.addresses.latitude number

Addresses-Latitude

Longitude
dataList.addresses.longitude number

Addresses-Longitude

Show In Directory
dataList.addresses.showInDirectory boolean

Addresses-ShowInDirectory

Congressional District
dataList.addresses.congressionalDistrict string

Addresses-CongressionalDistrict

Country Id
dataList.addresses.countryData.id uuid

Addresses-Country-CountryId

Country Name
dataList.addresses.countryData.name string

Addresses-Country-CountryName

Two Letter ISO Code
dataList.addresses.countryData.twoLetterIsoCode string

Addresses-Country-TwoLetterISOCode

Three Letter ISO Code
dataList.addresses.countryData.threeLetterIsoCode string

Addresses-Country-ThreeLetterISOCode

Country Code
dataList.addresses.countryData.code integer

Addresses-Country-CountryCode

Email
dataList.email email

Email

Image Uri
dataList.imageUri uri

ImageUri

Twitter
dataList.twitter uri

Twitter

LinkedIn
dataList.linkedIn uri

LinkedIn

emails
dataList.emails array of object

Emails

Is Primary Email
dataList.emails.primary boolean

Emails-IsPrimary

Email Address
dataList.emails.address email

Emails-EmailAddress

Type
dataList.emails.type string

Emails-Type

Show In Directory
dataList.emails.showInDirectory boolean

Emails-ShowInDirectory

phones
dataList.phones array of object

Phones

Phone Id
dataList.phones.id uuid

Phones-PhoneId

Is Primary Phone
dataList.phones.primary boolean

Phones-IsPrimary

Type
dataList.phones.type integer

Phones-Type

Country Id
dataList.phones.country.id uuid

Phones-Country-CountryId

Country Name
dataList.phones.country.name string

Phones-Country-CountryName

Two Letter ISO Code
dataList.phones.country.twoLetterIsoCode string

Phones-Country-TwoLetterISOCode

Three Letter ISO Code
dataList.phones.country.threeLetterIsoCode string

Phones-Country-ThreeLetterISOCode

Country Code
dataList.phones.country.code integer

Phones-Country-CountryCode

Show In Directory
dataList.phones.showInDirectory boolean

Phones-ShowInDirectory

Phone Number
dataList.phones.number string

Phones-PhoneNumber

Extension
dataList.phones.extension string

Phones-Extension

Type Name
dataList.phones.typeName string

Phones-TypeName

WebSite
dataList.webSite uri

WebSite

memberships
dataList.memberships array of object

Memberships

Membership Type
dataList.memberships.membershipType string

Memberships-MembershipType

Membership Type Id
dataList.memberships.membershipTypeId uuid

Memberships-MembershipTypeId

Membership Type Code
dataList.memberships.code string

Memberships-MembershipTypeCode

Expire Date
dataList.memberships.expireDate date-time

Memberships-ExpireDate

Grace Expire Date
dataList.memberships.graceExpireDate date-time

Memberships-GraceExpireDate

Inherited Membership Benefits
dataList.memberships.inheritedMembershipBenefits boolean

Memberships-InheritedMembershipBenefits

Renewal Url
dataList.memberships.renewalUrl uri

Memberships-RenewalUrl

Join Date
dataList.memberships.joinDate date-time

Memberships-JoinDate

Terminate Date
dataList.memberships.terminateDate date-time

Memberships-TerminateDate

Effective Date
dataList.memberships.effectiveDate date-time

Memberships-EffectiveDate

Category
dataList.category string

Category

categories
dataList.categories array of object

Categories

subCategories
dataList.categories.subCategories array of object

Categories-Subcategories

Subcategory Code
dataList.categories.subCategories.code string

Categories-Subcategories-SubcategoryCode

Subcategory Name
dataList.categories.subCategories.name string

Categories-Subcategories-SubcategoryName

Category Code
dataList.categories.code string

Categories-CategoryCode

Category Name
dataList.categories.name string

Categories-CategoryName

customFields
dataList.customFields array of object

CustomFields

Name
dataList.customFields.name string

CustomFields-Name

Caption
dataList.customFields.caption string

CustomFields-Caption

Value
dataList.customFields.value string

CustomFields-Value

Show In Directory
dataList.showInDirectory boolean

ShowInDirectory

links
dataList.links array of object

Links

Type
dataList.links.type string

Links-Type

Url
dataList.links.url uri

Links-Url

Old Id
dataList.oldId string

OldId