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

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

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

Create Group Types Retrieve Group Names Retrieve Group Types Update Group Type

Create Picklists Retrieve Picklists Update Picklist

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

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

Initiate Stage Execute Retrieve Status Retrieve Exceptions

PreferenceAttribute

Name

Description

Type

Additional information

Key

The key to identify the preferece attribute.

string

Required

Min length: 1

Value

The value of the attribute

string

Required

Min length: 1

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