API explorerChangelog
Overview

Sections

API explorer
Changelog

Theme switcher

Retrieve historical contact elements by alternate id

Using the combination of the alternateId and alternateIdType parameters, this method retrieves complete history of contact elements for a single profile, including any attached consent associations.

Profile-only consents, custom fields, groups, tags, and preferences will not be returned.

Header Parameters

Authorizationstring Required

Authorization token

Query Parameters

alternateIdTypestring Required

Name of the Alternate Id type associated with the specified Alternate Id.

alternateIdstring Required

Alternate Id value that uniquely identifies the profile that is being retrieved.

Path Parameters

clientIdstring Required

This is your organization’s MyPreferences account Id. A 404 is returned if this value is invalid.

Response

200
Object

Response Attributes

Addressesarray

Collection of addresses associated with the profile.

Show child attributes

Emailsarray

A collection of email addresses associated with the profile.

Show child attributes

PhoneNumbersarray

A collection of phone numbers associated with the profile. The phone number collection can also include any preferences and consents associated with it.

Show child attributes

ProfileIdinteger

Read-Only Id associated with the Profile.

IsActiveboolean

Defines whether the item is Active or Inactive.

Editedobject

Read-only system fields returned as part of an API response. These are updated automatically when a profile is created or modified.

Show child attributes

RegistrationConfirmedboolean

An optional field for clients to use at their discretion to accommodate scenarios in which customer profile verification is performed.

CustomerTypestring

An identifier used to classify a person by the type of customer. For example: Retail, Commercial, or Marketing.

PreserveConsentsboolean

Specifies whether to retain the contact element consents or deactivate them. To retain the contact element consents, set the value as True. If set to False, the contact element consents will be deactivated. This setting defaults to True, if not specified.

PreservePreferencesboolean

Specifies whether to retain the preferences or deactivate them. To retain the preferences, set the value as True. If set to False, the preferences will be deactivated. This setting defaults to True, if not specified.

CustomerNameobject

Name fields associated with the profile.

Show child attributes

DefaultLocalestring

Default Locale for the profile.

UpdateStatusstring

Read-Only field. 'Complete' if the record has been processed otherwise 'Pending Update'.

ReasonCodestring

An optional parameter that can be passed when deactivating a profile.

AlternateIdsarray

Collection of AlternateIds associated with the profile.

Show child attributes

400
Object
The request was invalid and cannot be processed. This may be a result of a malformed request. You must update the request before trying again.
401
Object
Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.
403
Object
The authentication credentials were insufficient to grant access to the requested resource. In most cases, your user may not have the appropriate permissions to access the requested resource. Verify User Group permissions for your user before trying again.
404
Object
The requested resource cannot be found. Most errors in this category are returned when a resource specified on the URL path is not found. In certain instances, it is also returned when a parameter specified in the request body is also not found. See error description for more details.
503
Object
The server is unable to handle your request due to a temporary condition. You must delay your request for some time before trying again. Notify PossibleNOW Support if it’s a continuous occurrence.
Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?