Overview

Initiate

Initiate request by specifying a segment name. Specify lastdatetime to retrieve data for a specific period.

You can also specify MatchCriteria to retrieve data for specific profiles. ProfileID, AlternateID, EmailAddress, and PhoneNumber are the supported match criteria.

When MatchCriteria is provided in a request, it is merged with the segment's predefined criteria to produce an output dataset that meets the segment configuration while including only the specified profiles. If MatchCriteria is not supplied, the API returns all profiles that match the search criteria defined in the segment.

The MatchType parameter is required when MatchCriteria is set to AlternateID. For ProfileID, EmailAddress, and PhoneNumber, it is optional. When provided, it filters the results to include only profiles that match the specified type. If omitted, the API processes the request solely based on the Values specified in the request.

When EmailAddress or PhoneNumber is used as the MatchCriteria, the MatchType can be a corresponding email or phone type. In this case, the returned data is filtered by the segment criteria but includes only the profiles from your request that also contain the specified email address or phone number.
When ProfileID is used, MatchType can be a customer type. In this case, the returned data is filtered according to the segment group criteria, including only the requested profiles that include the given customer type.

Header Parameters

Authorizationstring Required

Authorization token

Content-Typestring

Path Parameters

clientIdstring Required

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

segmentNamestring Required

Name of the MyPreferences segment to export.

Body Parameters

LastDateTimestring

Starting datetime to retrieve the updates. The LastDateTime support values up to the millisecond. The millisecond value will always be rounded to the nearest boundary to avoid records being skipped. For example, 000 through 002 becomes 003, 003 through 006 becomes 007, and 007 through 009 becomes 000 of the next higher value.

MatchCriteriastring

An optional parameter that allows you to restrict profiles that are returned by matching on specific identifiers such as Profile ID, Alternate ID, Email Address or Phone Number.

MatchTypestring

Filters the output dataset to only include profiles that match the specified MatchType. Required when MatchCriteria is AlternateId; otherwise, optional.

Valuesarray

Provide a collection of values that corresponds to your selected match criteria. For example, if you have chosen ProfileID as your match criteria, specify one or more profile IDs.

Show child attributes

Response

200

Object

Response Attributes

AccessTokeninteger

Secure token returned by the Initiate call, required as a URL parameter in all subsequent API requests.

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.

429

Object

Too Many Requests.

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.

Sections

Initiate

Header Parameters

Path Parameters

Body Parameters

Response

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Sections

Initiate

Header Parameters

Path Parameters

Body ParametersExpand all

Response

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Body Parameters