< Back to home

HoldingAddress

Either a new contact's address or an existing contact's holding address. A contact can have multiple addresses but must always have at least one address. Each contact must have exactly one address where each of the following properties is true: IsMailing, IsBilling and IsDelivery. Note that these can all be set on one address or spread across multiple addresses.

Properties

Name Type Description Required
AddressId Int32 (Nullable) The unique Id of this address in SubscriberCRM. This will only be filled for existing addresses of existing Contacts. No
ContactId Int32 (Nullable) The Contact's Id. This will only be filled for addresses of existing Contacts. No
Description String No
Position String No
Department String No
Organisation String No
AddressLabel String No
AddressLine1 String No
AddressLine2 String No
AddressLine3 String No
Town String No
CountyId Int32 The Id of the County. Lookup: County list. -1 can be entered if this is not known. Yes
Postcode String No
CountryId Int32 The Id of the Country. Lookup: Country list. -1 can be entered if this is not known. Yes
Phone String No
EvePhone String No
Mobile String No
Email String No
Fax String No
Website String No
AddressTypeId Int32 (Nullable) No
IsBilling Boolean Determines if this is the Billing address. A Contact must always have one billing address. Yes
IsMailing Boolean Determines if this is the Mailing address. A Contact must always have one mailing address. Yes
IsDelivery Boolean Determines if this is the Delivery address. A Contact must always have one delivery address. Yes
IsDeleted Boolean Determines if this address should be deleted. Only used for existing Contacts. No
GridN String No
GridE String No
Latitude String No
Longitude String No
CensationCode String No
Constituency String No
MailReturned_Date DateTime (Nullable) No
MailReturned_ReasonId Int32 (Nullable) No
StartDate DateTime (Nullable) This would usually be the date the address was added or when the address should be valid from. No
EndDate DateTime (Nullable) The date on which the address should no longer be used. No
UseForEmailing Boolean Determines if this address should be used when sending emails. Defaults to true. No
Ward String No
ElectoralRegion String No

Endpoints

Url Actions Description
api/holdingaddress/?holdingId={holdingId}&addressId={addressId} GET Gets a single Address.
api/holdingaddress/contact/{id} GET Lists all Addresses for a contact.
api/holdingaddress POST Updates an existing Address.