Contact Object

Applies to QAComplete 12.71 SaaS, last modified on January 18, 2021

A Contact object represents a contact, such as a customer or a sales lead. Using the QAComplete Web API, you can add, load, update, and delete contacts.

Some string property values (for example, Status) are based on choice lists defined in your QAComplete project. You can find these values in Contacts > Show Contacts > Actions > Manage Choice Lists.

Requirements

To manage contacts, the web service user must be in a security group that has the corresponding privileges – Read, Add, Update, or Delete for Contacts. You can view or set these privileges in  > Setup > Security > Security Groups > Manage Security Rights > select user group.

Properties

Custom1 … Custom10  :  string (max 8000 chars)

Values of custom fields from 1 to 10.

Custom11 … Custom90  :  string (max 100 chars)

Values of custom fields from 11 to 90.

CustomFieldName1 … CustomFieldName90  :  string (max 30 chars)

The names of custom fields.

CustomFields  :  array of strings

An array of custom field values.

CustomFieldNames  :  array of strings

An array of custom field names.

ContactId  :  integer

The unique identifier of the contact.

ContactPerson  :  string (max 50 chars)

The first and last names of the person.

CompanyName  :  string (max 50 chars)

The company that the person represents.

Email  :  string (max 255 chars)

The person’s email address.

Title  :  string (max 255 chars)

The job title.

XML entities in the title are double encoded:

& – &

< – &amp;#60;

> – &amp;#62;

Status  :  string (max 100 chars)

The contact status based on a choice list.

ContactType  :  string (max 100 chars)

The contact type based on a choice list.

Date1stContact  :  dateTime

The date of the first contact with this person.

DateCallBack  :  dateTime

The date to call this person back.

AssigneeUserId  :  integer

The ID of the user the contact is assigned to, or 0 if the contact is not assigned to anyone.

OwnerUserId  :  integer

The ID of the user who owns the contact.

PrimaryAddress  :  string

The person’s primary address. Can include HTML markup. Default value: empty string.

FolderId  :  integer

The ID of the folder containing the contact, or 0 if the contact is not in any folder.

OutlookId  :  string (max 255 chars)

Reserved.

AssignedToName  :  string (max 78 chars)

The name of the user assigned to the contact (in the Lastname, Firstname format).

DateCreated  :  dateTime

The date and time the contact was created in QAComplete.

DateUpdated  :  dateTime

The date and time the contact was last updated.

ImportId  :  integer

For importing: the import batch number. Default: 0.

NbrEvents  :  integer

The number of calendar events attached to the contact. Default: 0.

NbrFiles  :  integer

The number of files attached to the contact. Default: 0.

NbrNotes  :  integer

The number of notes attached to the contact. Default: 0.

OwnerName  :  string (max 78 chars)

The name of the user who created the contact (in the Lastname, Firstname format).

UpdateUserId  :  integer

The ID of the user who last updated the contact.

UserName  :  string (max 78 chars)

The name of the user who last updated the contact (in the Lastname, Firstname format).

Relevant Operations

Example

XML

<Contact>
  <ContactId>7</ContactId>
  <ContactPerson>John Smith</ContactPerson>
  <CompanyName>Smith & Doe Inc.</CompanyName>
  <Title>Developer</Title>
  <StatusCode>Active</StatusCode>
  <ContactType>Vendor</ContactType>
  <Date1stContact>2012-02-20T00:00:00</Date1stContact>
  <DateCallBack>2014-07-29T00:00:00</DateCallBack>
  <AssigneeUserId>27942</AssigneeUserId>
  <OwnerUserId>27534</OwnerUserId>
  <FolderId>52359</FolderId>
  <AssignedToName>Fry, Alex</AssignedToName>
  <DateCreated>2014-05-30T14:28:18.028</DateCreated>
  <DateUpdated>2014-07-28T05:54:22</DateUpdated>
  <ImportId>0</ImportId>
  <NbrEvents>0</NbrEvents>
  <NbrFiles>0</NbrFiles>
  <NbrNotes>1</NbrNotes>
  <OwnerName>Davis, Eugeny</OwnerName>
  <UpdateUserId>27534</UpdateUserId>
  <UserName>Fry, Alex</UserName>
</Contact>

See Also

Contacts_Add Operation
Contacts_Load Operation
Contacts Operations

Highlight search results