Education Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Introduction to Education Cloud
Release Notes
Education Cloud Data Model Overview
Education Cloud Standard Objects
Education Cloud Fields on Standard Objects
Education Cloud Associated Objects
Education Cloud Standard Value Set Names and Standard Picklist Fields
Education Cloud Tooling API Objects
Education Cloud Business APIs
Fundraising
Fundraising Standard Objects
Fundraising Fields on Other Objects
ContactPointAddress
ContactProfile
ListEmail
Fundraising Business APIs
Fundraising Invocable Actions
Fundraising Metadata API Types
Fundraising Tooling API Objects
PDF

ContactPointAddress

Represents a contact’s billing or shipping address, which is associated with an individual or a person account. This object is available in API version 61.0 and later.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Special Access Rules

This object is available only if the FundraisingAccess license is enabled and the Fundraising User system permission is assigned to users.

Fields

Field Details
ActiveFromDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date when the contact’s address became active.
ActiveToDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The date when the contact’s address is no longer active.
Address
Type
address
Properties
Filter, Nillable
Description
The full address.
AddressType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The type of address.
Valid values are:
  • Billing
  • Shipping
BestTimeToContactEndTime
Type
time
Properties
Create, Filter, Nillable, Sort, Update
Description
The latest time to contact the individual.
BestTimeToContactStartTime
Type
time
Properties
Create, Filter, Nillable, Sort, Update
Description
The earliest time to contact the individual.
BestTimeToContactTimezone
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The timezone applied to the best time to contact the individual.
City
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The address city.
ContactPointPhoneId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The primary phone number associated with this address.
This field is a relationship field.
Relationship Name
ContactPointPhone
Relationship Type
Lookup
Refers To
ContactPointPhone
Country
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The address country.
GeocodeAccuracy
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The level of accuracy of a location’s geographical coordinates compared with its physical address. A geocoding service typically provides this value based on the address’s latitude and longitude coordinates.
Valid values are:
  • Address
  • Block
  • City
  • County
  • ExtendedZip
  • NearAddress
  • Neighborhood
  • State
  • Street
  • Unknown
  • Zip
IsDefault
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether a contact’s address is the preferred method of communication (true) or not (false).
The default value is false.
IsPrimary
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether a contact’s address is their primary address (true) or not (false). 
The default value is false.
IsThirdPartyAddress
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the address is associated with a third party (true) or not (false). 
The default value is false.
IsUndeliverable
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether the address is undeliverable (true) or not (false).
The default value is false.
LastAddressStdDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The most recent date and time that the address was evaluated by the address standardization provider.
LastAddressStdStatus
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The most recent status received from the address standardization provider.
LastChangeOfAddressDate
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The most recent date and time that the address was evaluated by the change of address provider.
LastChangeOfAddressStatus
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The status of the latest change of address request.
LastReferencedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last referenced a record related to this record.
LastViewedDate
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.
Latitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with Longitude to specify the precise geolocation of the address. Acceptable values are numbers between –90 and 90 with up to 15 decimal places.
Longitude
Type
double
Properties
Create, Filter, Nillable, Sort, Update
Description
Used with Latitude to specify the precise geolocation of the address. Acceptable values are numbers between –180 and 180 with up to 15 decimal places.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Required. The name of the contact point address record.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The ID of the account’s owner associated with this contact.
This field is a polymorphic relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
Group, User
ParentId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the contact’s parent record. Only an individual or account can be a contact’s parent.
This field is a polymorphic relationship field.
Relationship Name
Parent
Relationship Type
Master-detail
Refers To
Account, Individual (the master object)
PostalCode
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The address postal code.
PreferenceRank
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The preference rank when there are multiple contact point addresses.
SeasonalEndDay
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The day when the seasonal address of the contact is replaced by the default address.
Valid values are: 1–31
SeasonalEndMonth
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The month when the seasonal address of the contact is replaced by the default address.
Valid values are: 1–12
SeasonalStartDay
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The day when the seasonal address of the contact replaces the default address.
Valid values are: 1–31
SeasonalStartMonth
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The month when the seasonal address of the contact replaces the default address.
Valid values are: 1–12
State
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The address state.
Street
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The address street.
UsageType
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The usage type of this address. For instance, whether it’s a work address or a home address.
Valid values are:
  • Home
  • Inactive
  • Temporary
  • Work