Contact actions

Get a contact

Gets a single record by iMIS ID.

Note: Can be either a person or an organization. The contactType field specifies what type of record was returned. Fields corresponding to only one type will be null if not appropriate for the returned contact type (e.g. "Birth Date" is only on persons, and will be null for organizations).

Inputs

Field	Type
iMIS ID	string

Outputs

Code	Description	Type
billingCategory	Billing Category	string
birthDate	Birth Date	string(date)
contactKey	Contact Key	string
contactType	Contact Type	string
email	Email	string
fax	Fax	string
firstName	First Name	string
functionalTitle	Functional Title	string
gender	Gender	string
homePhone	Home Phone	string
id	iMIS ID	string
informalName	Informal Name	string
isActive	Is Active	boolean
isMember	Is Member	boolean
joinDate	Join Date	string(date)
lastName	Last Name	string
majorKey	Major Key	string
memberType	Member Type	string
middleName	Middle Name	string
mobilePhone	Mobile Phone	string
name	Name	string
namePrefix	Name Prefix	string
nameSuffix	Name Suffix	string
organizationId	Organization ID	string
organizationName	Organization Name	string
paidThruDate	Paid Thru	string(date)
renewedThruDate	Renewed Thru	string(date)
status	Status	string
workPhone	Work Phone	string

Get a contact's picture

Retrieve a contact's picture.

Inputs

Name	Type	Description
iMIS ID	string	The iMIS ID of the person whose picture should be retrieved

Outputs

Code	Description	Type
id	iMIS ID	string
pictureData	Picture Data	bytes

Create a contact

Create a new individual record in iMIS.

Inputs

Name	Description	Type
Billing Category	The contact's billing category name	string
Birth Date	The contact's birth date	string
Email	The contact's primary email address	string
Fax	The contact's fax number	string
First Name	The contact's first name	string
Functional Title	The contact's functional title code value	string
Gender	The contact's gender code (e.g. "M", "F", or any other defined codes)	string
Home Phone	The contact's home phone number	string
Informal Name	The contact's informal name (or nickname)	string
Join Date	The contact's join date	string
Last Name	The contact's last name	string
Major Key	The contact's major key field	string
Member Type	The contact's member type code (e.g. "NM" or "WEB")	string
Middle Name	The contact's middle name	string
Mobile Phone	The contact's mobile phone number	string
Name Prefix	The contact's name prefix (e.g. "Mrs.")	string
Name Suffix	The contact's name suffix (e.g. "Jr.")	string
Organization Name	The name of the organization that this contact belongs to (not used if Parent Organization ID is set)	string
Parent Organization ID	Specify the iMIS ID of a parent organization to link this person to	string
Status	The contact's status code (e.g. "A", "D", "X")	string
Work Phone	The contact's work phone number	string

Outputs

Code	Description	Type
billingCategory	Billing Category	string
birthDate	Birth Date	string(date)
contactKey	Contact Key	string
contactType	Contact Type	string
email	Email	string
fax	Fax	string
firstName	First Name	string
functionalTitle	Functional Title	string
gender	Gender	string
homePhone	Home Phone	string
id	iMIS ID	string
informalName	Informal Name	string
isActive	Is Active	boolean
isMember	Is Member	boolean
joinDate	Join Date	string(date)
lastName	Last Name	string
majorKey	Major Key	string
memberType	Member Type	string
middleName	Middle Name	string
mobilePhone	Mobile Phone	string
name	Name	string
namePrefix	Name Prefix	string
nameSuffix	Name Suffix	string
organizationId	Organization ID	string
organizationName	Organization Name	string
paidThruDate	Paid Thru	string(date)
renewedThruDate	Renewed Thru	string(date)
status	Status	string
workPhone	Work Phone	string

Create an organization

Create a new organization record in iMIS.

Inputs

Name	Description	Type
Billing Category	The organization's billing category name	string
Email	The organization's primary email address	string
Fax	The organization's fax number	string
Join Date	The organization's join date	string
Major Key	The organization's major key field	string
Member Type	The organization's member type code (e.g. "NM" or "WEB")	string
Organization Name	The name of this organization	string
Status	The organization's status code (e.g. "A", "D", "X")	string
Website URL	The website URL for this organization's homepage	string
Work Phone	The organization's work phone number	string

Outputs

Code	Description	Type
billingCategory	Billing Category	string
birthDate	Birth Date	string(date)
contactKey	Contact Key	string
contactType	Contact Type	string
email	Email	string
fax	Fax	string
firstName	First Name	string
functionalTitle	Functional Title	string
gender	Gender	string
homePhone	Home Phone	string
id	iMIS ID	string
informalName	Informal Name	string
isActive	Is Active	boolean
isMember	Is Member	boolean
joinDate	Join Date	string(date)
lastName	Last Name	string
majorKey	Major Key	string
memberType	Member Type	string
middleName	Middle Name	string
mobilePhone	Mobile Phone	string
name	Name	string
namePrefix	Name Prefix	string
nameSuffix	Name Suffix	string
organizationId	Organization ID	string
organizationName	Organization Name	string
paidThruDate	Paid Thru	string(date)
renewedThruDate	Renewed Thru	string(date)
status	Status	string
workPhone	Work Phone	string

Update a person

Updates an indivudal person's record.

Inputs

Name	Description	Type
iMIS ID	Required. The iMIS ID / record to update.	string
Billing Category	The contact's billing category name	string
Birth Date	The contact's birth date	string(date)
Email	The contact's primary email address	string
Fax	The contact's fax number	string
First Name	The contact's first name	string
Functional Title	The contact's functional title code value	string
Gender	The contact's gender code (e.g. "M", "F", or any other defined codes)	string
Home Phone	The contact's home phone number	string
Informal Name	The contact's informal name (or nickname)	string
Join Date	The contact's join date	string(date)
Last Name	The contact's last name	string
Major Key	The contact's major key field	string
Member Type	The contact's member type code (e.g. "NM" or "WEB")	string
Middle Name	The contact's middle name	string
Mobile Phone	The contact's mobile phone number	string
Name Prefix	The contact's name prefix (e.g. "Mrs.")	string
Name Suffix	The contact's name suffix (e.g. "Jr.")	string
Organization Name	The name of the organization that this contact belongs to (not used if Parent Organization ID is set)	string
Parent Organization ID	Specify the iMIS ID of a parent organization to link this person to	string
Status	The contact's status code (e.g. "A", "D", "X")	string
Work Phone	The contact's work phone number	string

Outputs

Code	Description	Type
billingCategory	Billing Category	string
birthDate	Birth Date	string(date)
contactKey	Contact Key	string
contactType	Contact Type	string
email	Email	string
fax	Fax	string
firstName	First Name	string
functionalTitle	Functional Title	string
gender	Gender	string
homePhone	Home Phone	string
id	iMIS ID	string
informalName	Informal Name	string
isActive	Is Active	boolean
isMember	Is Member	boolean
joinDate	Join Date	string(date)
lastName	Last Name	string
majorKey	Major Key	string
memberType	Member Type	string
middleName	Middle Name	string
mobilePhone	Mobile Phone	string
name	Name	string
namePrefix	Name Prefix	string
nameSuffix	Name Suffix	string
organizationId	Organization ID	string
organizationName	Organization Name	string
paidThruDate	Paid Thru	string(date)
renewedThruDate	Renewed Thru	string(date)
status	Status	string
workPhone	Work Phone	string

Update an organization

Updates an organization's record.

Inputs

Name	Description	Type
iMIS ID	The iMIS ID (Also referred to as: Contact ID, Party ID)	string
Billing Category	The organization's billing category name	string
Email	The organization's primary email address	string
Fax	The organization's fax number	string
Join Date	The organization's join date	string(date)
Major Key	The organization's major key field	string
Member Type	The organization's member type code (e.g. "NM" or "WEB")	string
Organization Name	The name of this organization	string
Status	The organization's status code (e.g. "A", "D", "X")	string
Website URL	The website URL for this organization's homepage	string
Work Phone	The organization's work phone number	string

Outputs

Code	Description	Type
billingCategory	Billing Category	string
birthDate	Birth Date	string(date)
contactKey	Contact Key	string
contactType	Contact Type	string
email	Email	string
fax	Fax	string
firstName	First Name	string
functionalTitle	Functional Title	string
gender	Gender	string
homePhone	Home Phone	string
id	iMIS ID	string
informalName	Informal Name	string
isActive	Is Active	boolean
isMember	Is Member	boolean
joinDate	Join Date	string(date)
lastName	Last Name	string
majorKey	Major Key	string
memberType	Member Type	string
middleName	Middle Name	string
mobilePhone	Mobile Phone	string
name	Name	string
namePrefix	Name Prefix	string
nameSuffix	Name Suffix	string
organizationId	Organization ID	string
organizationName	Organization Name	string
paidThruDate	Paid Thru	string(date)
renewedThruDate	Renewed Thru	string(date)
status	Status	string
workPhone	Work Phone	string

Get an address for a contact

Retrieves an address for a contact.

Inputs

Name	Description	Type
iMIS ID	The iMIS ID to get the addresses for	string
Address Purpose	Must be a well-defined address purpose name in iMIS	string

Outputs

Field	Name	Type	Description
addressId	Address ID	string	Unique ID for this address record.
addressLines	Address Lines	string	Newline-separated address street lines.
city	City Name	string	City name on the address.
stateProvinceCode	State/Province Code	string	Abbreviated code for the state/province.
postalCode	Postal Code	string	Postal or ZIP code.
countryCode	Country Code	string	Abbreviated country code.
phone	Phone Number	string	Formatted phone number for this address.
email	Email Address	string	Email for this address.
fullAddress	Full Address	string	Full computed address with newlines.
nameAndFullAddress	Name and Full Address	string	Full computed address with the contact's name on the first line.
addressPurpose	Address Purpose	string	Full computed address with the contact's name on the first line.
communicationPreferences	Communication Preference List	Array(string)	Address purpose (category) names.

Get all addresses for a contact

Retrieves a list of all addresses for a contact.

Inputs

Name	Description	Type
iMIS ID	The iMIS ID to get the addresses for	string

Outputs

Code	Description	Type
value	Address List	array[Address]

Address

Field	Name	Type	Description
addressId	Address ID	string	Unique ID for this address record.
addressLines	Address Lines	string	Newline-separated address street lines.
city	City Name	string	City name on the address.
stateProvinceCode	State/Province Code	string	Abbreviated code for the state/province.
postalCode	Postal Code	string	Postal or ZIP code.
countryCode	Country Code	string	Abbreviated country code.
phone	Phone Number	string	Formatted phone number for this address.
email	Email Address	string	Email for this address.
fullAddress	Full Address	string	Full computed address with newlines.
nameAndFullAddress	Name and Full Address	string	Full computed address with the contact's name on the first line.
addressPurpose	Address Purpose	string	Full computed address with the contact's name on the first line.
communicationPreferences	Communication Preference List	Array(string)	Address purpose (category) names.

Update a contact's mailing address

Inputs

Name	Type	Description
iMIS ID	string	The iMIS ID of the address to update
Address 1	string	Address Line 1
Address 2	string	Address Line 2
Address 3	string	Address Line 3
City Name	string	City name on the address
State/Province Code	string	Abbreviated code for the state/province
Postal Code	string	Postal or ZIP code
Country Code	string	Abbreviated country code
Phone Number	string	Formatted phone number for this address
Email Address	string	Email for this address
Fax Number	string	Formatted fax number for this address

Outputs

Field	Name	Type	Description
addressId	Address ID	string	Unique ID for this address record.
addressLines	Address Lines	string	Newline-separated address street lines.
city	City Name	string	City name on the address.
stateProvinceCode	State/Province Code	string	Abbreviated code for the state/province.
postalCode	Postal Code	string	Postal or ZIP code.
countryCode	Country Code	string	Abbreviated country code.
phone	Phone Number	string	Formatted phone number for this address.
email	Email Address	string	Email for this address.
fullAddress	Full Address	string	Full computed address with newlines.
nameAndFullAddress	Name and Full Address	string	Full computed address with the contact's name on the first line.
addressPurpose	Address Purpose	string	Full computed address with the contact's name on the first line.
communicationPreferences	Communication Preference List	Array(string)	Address purpose (category) names.

Find contacts

Searches for one or more contact or organization records in iMIS by certain criteria.

Note: Supports Pagination and Search Filters.

Inputs

Name	Description	Type
First Name	Contact's first name (supports filters)	string
Last Name	Contact's last name (supports filters)	string
Full Name	Contact's full name (supports filters)	string
Primary Email	Contact's primary email address (supports filters)	string
Member Type Code	Contact's member type code (supports filters)	string
Company Name	Contact's organization name (supports filters)	string
Filter Record Types	Filter record types (people, organizations)	dropdown [All, People, Organizations]
Filter Deleted Status	Filter deleted status (marked for deletion)	dropdown [All, MarkedForDelete, NotMarkedForDelete]

Outputs

Code	Description	Type
value	Contact List	array[Contact]

Contact:

Code	Description	Type
billingCategory	Billing Category	string
birthDate	Birth Date	string(date)
contactKey	Contact Key	string
contactType	Contact Type	string
email	Email	string
fax	Fax	string
firstName	First Name	string
functionalTitle	Functional Title	string
gender	Gender	string
homePhone	Home Phone	string
id	iMIS ID	string
informalName	Informal Name	string
isActive	Is Active	boolean
isMember	Is Member	boolean
joinDate	Join Date	string(date)
lastName	Last Name	string
majorKey	Major Key	string
memberType	Member Type	string
middleName	Middle Name	string
mobilePhone	Mobile Phone	string
name	Name	string
namePrefix	Name Prefix	string
nameSuffix	Name Suffix	string
organizationId	Organization ID	string
organizationName	Organization Name	string
paidThruDate	Paid Thru	string(date)
renewedThruDate	Renewed Thru	string(date)
status	Status	string
workPhone	Work Phone	string