API explorerChangelog
Overview

Sections

API explorer
Changelog

Theme switcher

Retrieve program groups (Include Matching)

This method allows you to retrieve a specific set of program groups, programs, and filters that match the custom property criteria specified as query parameters in your request.

It returns all program groups that match on the custom property criteria specified in the request, and only includes the nested program groups, programs, and filters that also match on the same custom property criteria.

What are custom properties?

Custom Properties are a collection of key-value pairs that can be attached to Program Groups, Programs, and Filters. The key is the name of the property and the value is the content.

While the actual customer data, such as their choices, consents, preferences, etc. helps you deliver an individualized experience, custom properties allow you to personalize it for specific audience segments. For example, a first time visitor may want to see options related to onboarding, whereas an existing customer might get a highly personalized experience.

You can define as many of these key-value pairs to support any level of specializations ranging from micro experiences to comprehensive preference centers and everything in between.

Example:

https://{Base URL}/{client_id}/ProgramGroups/IncludeMatching?Jurisdication=EU&OnlineOnly=True&CheckingProgram

In this example, the API will return all program groups and only those associated nested program groups, programs, and filters where custom properties exist with the following values:

  • "Jurisdiction" = EU,
  • "OnlineOnly" = True,
  • "CheckingProgram" exists with ANY value, because no value was supplied in the request.

Header Parameters

Authorizationstring Required

Authorization token

Content-Typestring

Type of the data being sent in the request or the data that is expected in the response. Supports application/json.

Query Parameters

localestring

A valid locale ID associated with a text tag. If specified, the API response will only include text tags for the specified locale.

Path Parameters

clientIdstring Required

This is your MyPreferences account Id.

Response

200
Object
The request was successfully processed.

Response Attributes

ProgramGrouparray

A collection of program groups.

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.

Response Attributes

Messagestring
Nullable:
True
401
Object
Authentication credentials are missing or incorrect. You must verify your ClientId, UserId, and Authorization Scheme before trying again.

Response Attributes

Messagestring
Nullable:
True
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.

Response Attributes

Messagestring
Nullable:
True
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.

Response Attributes

Messagestring
Nullable:
True
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?