The contact object holds contact information for a person associated with a partner account in your program. You can create, retrieve, update, and delete a contact, as well as list all contacts.
impact.com also automatically creates a contact object for each public account user of all the partner accounts in your program. These system-created contacts are identifiable by an M prefix in their contact Id value. They can be retrieved, listed, and only partially updated.
Attributes
Id string
Id stringUnique identifier for the object referred to as the impact.com Contact Id_.
FirstName string
FirstName stringThe contact's first name.
LastName string
LastName stringThe contact's last name.
EmailAddress string
EmailAddress stringThe contact's email address.
Title string
Title stringThe contact's title, which can only be assigned to created contacts (not existing contacts with an impact.com account).
ProfileImage URI
ProfileImage URIThe URI to the contact's profile image.
WorkPhoneNumberCountry string
WorkPhoneNumberCountry stringThe two letter country code for the contact's work phone number. See ISO 3166.
WorkPhoneNumber string
WorkPhoneNumber stringThe contact's work phone number.
CellphoneNumberCountry string
CellphoneNumberCountry stringThe two letter country code for the contact's cellphone number. See ISO 3166.
CellphoneNumber string
CellphoneNumber stringThe contact's cellphone number.
Editable boolean
Editable booleanHas the value true if the contact can be fully edited (user-created contact) or the value false if the contact cannot be fully edited (system-created contact). System-created contacts can only be updated with values for the Title and Labels parameters.
Labels array
Labels arrayLabels that can be created for a contact. This is an array of strings that can be assigned to any contact.
Account object
Account objectLists the account Id and Name of the partner accounts that this contact is associated with.
View child attributes
Idstring
The contact's Partner account ID.
Namestring
The contact's Partner account name.
Uri string
Uri stringThe contact's direct URI to view only their contact information.
User-Created Contact
{
"Id": "2750",
"FirstName": "Wile",
"LastName": "Coyote",
"EmailAddress": "[email protected]",
"Title": "Acme Partner Manager",
"ProfileImage": "/Advertisers/<AccountSID>/Campaigns/1000/Contacts/2750/ProfileImage",
"WorkPhoneNumberCountry": "US",
"WorkPhoneNumber": "8051231234",
"CellphoneNumberCountry": "US",
"CellphoneNumber": "8055555555",
"Editable": "true",
"Labels": [
"Primary Contact",
"Partner"
],
"Accounts": {
"Account": {
"Id": "10000",
"Name": "Acme Partner"
}
},
"Uri": "/Advertisers/<AccountSID>/Campaigns/1000/Contacts/2750"
}System-Created Contact
{
"Id": "M1369520",
"FirstName": "Road",
"LastName": "Runner",
"EmailAddress": "[email protected]",
"Title": "Acme Partner Associate",
"ProfileImage": "/Advertisers/<AccountSID>/Campaigns/1000/Contacts/M1369520/ProfileImage",
"WorkPhoneNumberCountry": "US",
"WorkPhoneNumber": "8051231234",
"CellphoneNumberCountry": "US",
"CellphoneNumber": "8055555555",
"Editable": "false",
"Labels": [
"Secondary Contact",
"Partner"
],
"Accounts": {
"Account": {
"Id": "10000",
"Name": "Acme Partner"
}
},
"Uri": "/Advertisers/<AccountSID>/Campaigns/1000/Contacts/M1369520"
}