Profiles REST API
Getting Started
Introduction Authorization Swagger
Endpoints
Profiles
Add Profile Add Consents to Profile Add Consents by Alternate Id Associate Consents with Filters for a Profile Remove Consent associations with a Filter from a Profile Retrieve Consent and Filter Associations by Profile Activate Profile Deactivate Profile Retrieve Profile Retrieve Profile by Alternate Id Retrieve Profiles by Name Retrieve Profiles by Partial Name Retrieve Group of Profiles by Alternate Id Retrieve Group of Profiles by Email Address Retrieve Group of Profiles by Group Name Retrieve Group of Profiles by Phone Number Retrieve Group of Profiles by Profile Id Update Profile (PATCH) Update Profile by Alternate Id (PATCH) Update Profile (PUT) Update Profile by Alternate Id (PUT) Delete Profile
Preferences
Add Preferences Add Preferences by Alternate Id Retrieve Preferences by Profile Id Retrieve Historical Preferences by Profile Id Retrieve Preferences by Address Retrieve Preferences by Alternate Id Retrieve Preferences by Custom Fields Retrieve Preferences by Custom Fields SelectList Retrieve Preferences by Email Retrieve Preferences by Name Retrieve Preferences by Partial Name Retrieve Preferences by Phone Retrieve Preferences by Preference Attributes Retrieve Preferences by Tags Retrieve Group Preferences by Alternate Id Retrieve Group Preferences by Email Address Retrieve Group Preferences by Group Name Retrieve Group Preferences by Phone Number Retrieve Group Preferences by Profile Id Archive Preferences
Configuration
Profile Configuration
Consents
Create Consent Types Retrieve Consent Status Retrieve Consent Types Update Consent Type
Contact Types
Create Address Types Create Alternate Id Types Create Customer Types Create Email Types Create Phone Types Retrieve Address Types Retrieve Alternate Id Types Retrieve Customer Types Retrieve Email Types Retrieve Phone Types Update Address Type Update Alternate Id Type Update Customer Type Update Email Type Update Phone Type
Custom Fields
Create Date Time Custom Fields Create Numeric Custom Fields Create Select List Custom Fields Create Text Custom Fields Retrieve Update Rules Retrieve Custom Fields Retrieve Date Time Custom Fields Retrieve Numeric Custom Fields Retrieve Select List Custom Fields Retrieve Text Custom Fields Update Date Time Custom Field Update Numeric Custom Field Update Select List Custom Field Update Text Custom Field
Groups
Create Group Types Retrieve Group Names Retrieve Group Types Update Group Type
Picklists
Create Picklists Retrieve Picklists Update Picklist
Tags
Retrieve Tags Delete Tags
Preference Configuration
Data Export Configuration
Segment Group
Retrieve Segment Group List Retrieve Segment Group Create Segment Group Update Segment Group Retrieve Segment Group Permissions Create Segment Group Permissions Update Segment Group Permissions Delete Segment Group
Segments
Retrieve Segment List Retrieve Segment Create Segment Retrieve Segment List Filtered Update Segment Retrieve Segment Permissions Create Segment Permissions Update Segment Permissions Delete Segment
Bulk API
Export
Initiate Retrieve Status Retrieve Data
Import
Initiate Stage Execute Retrieve Status Retrieve Exceptions

Introduction

The Profiles API is a powerful RESTful Web Service Framework for interacting with Profiles. It provides you with complete access to User Profiles, Consents, Preferences and Configurations.

The Profiles API includes support for the following three areas: Profiles, Preferences and Configuration. It also provides a set of Synchronization APIs to transfer configuration data between Profiles accounts, and a Profiles Bulk API framework to support high-volume preference data transfers.

  • Profiles allow you to create, retrieve, update, deactivate and delete profiles. It provides a framework for progressive profiling, tagging user activity, grouping and householding, managing and collecting consents, and a host of other activities related to managing a unified view of a user’s data.
  • Preferences are designed for all things “preference”. They allow you to add preferences to a profile, retrieve preferences for a profile, and deactivate preferences globally or across specific offerings within a profile.
  • Configuration is divided into Profile Configuration and Preference Management configuration. These APIs allow you to build dynamic experiences for collecting profile information, preferences, and consents across every touchpoint within your customers' journeys.
  • Synchronization API is a purpose-built API that helps you easily promote your Profiles configuration from one account to another.
  • Bulk API is an asynchronous RESTful API designed to support bulk import and export of data from Profiles. It allows you to import large sets of customer profiles, including preferences and consents into Profiles. You can also leverage it for periodical imports to sync Profiles with customer data captured in other applications.

On most GET calls, you can include one or more query parameters on the request URI to filter your dataset. See the individual GET calls to see the list of supported query parameters.

All parameters are optional unless noted otherwise.

Copyright 2020 PossibleNOW, Inc. and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us at support@possiblenow.com.

Copyright © 2026 PossibleNOW, Inc. and/or its affiliates. All rights reserved. | 3.0.0.7