Table of Contents
Get Started
- Quick Start
-
Use Cases
- Create and Process a Transaction
- Create and Process a Queued Transaction
- Create and Process a Transfer Points Transaction
- Display Member Activities
- Enroll a Member to a Loyalty Program
- Assign a Voucher to a Loyalty Member
- Enroll a Member Into an Enrollable Promotion
- Get a Range of Products Available for Redemption
- Merge Multiple Members
- Redeem a Voucher in a Single Step
- Update a Loyalty Member
- Learn More
- Reference
- Deprecated Paths and Endpoints
- Change History
Tasks
- (Deprecated) Loyalty Member Enrollments
- Create a loyalty promotion enrollment collection for a member (Deprecated)
- Delete a loyalty promotion to which a member is enrolled (Deprecated)
- Get a loyalty promotion to which a member is enrolled (Deprecated)
- Get all loyalty promotions to which a member is enrolled (Deprecated)
- Update a loyalty promotion to which a member is enrolled (Deprecated)
- (Deprecated) Loyalty Members
- Create a loyalty member (Deprecated)
- Get a loyalty member (Deprecated)
- Get all loyalty members (Deprecated)
- Update a loyalty member (Deprecated)
- (Deprecated) Member Attributes
- (Deprecated) Member Contacts
- (Deprecated) Member Point Balances
- (Deprecated) Member Promotion Attributes
- (Deprecated) Member Promotions
- (Deprecated) Member Referrals
- (Deprecated) Member Tiers
- (Deprecated) Member Transactions
- (Deprecated) Member Vouchers
- (Deprecated) Loyalty Transactions
- Get a loyalty transaction (Deprecated)
- Get all loyalty transactions (Deprecated)
- Process a loyalty transaction (Deprecated)
- Processes a loyalty transaction for a given transaction number.
- Update a loyalty transaction (Deprecated)
- (Deprecated) Accrual Items
- (Deprecated) Loyalty Promotions
- (Deprecated) Redemption Items
- (Deprecated) Transaction Vouchers
- (Deprecated) Loyalty Vouchers
- Accounts
- Assign accounts
- Create an account
- Delete an account
- Find duplicates
- Get all accounts
- Get an account
- Get information about financial customers - Internal
- Update an account
- Account Attachments
- Account Extension Bases
- Account Hierarchy
- Account Resources
- Create a sales team member
- Delete a sales team member
- Get a sales team member
- Get all sales team members
- Update a sales team member
- Smart Actions
- Execute an action
- Generate smart actions
- Get a smart action - Not Supported
- Get action evaluation attributes - Not Supported
- Get all smart actions
- Get attributes - Not Supported
- Get entities - Not Supported
- Get mass or composite actions for the selected records
- Get object functions - Not Supported
- Process mass action - Not Supported
- Process mass or composite action
- Smart Action REST Path Parameter Definitions
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Account Rollups
- Account Team
- Additional Identifier
- Additional Names
- Addresses
- Create an address
- Delete an address
- Get all addresses
- Get an address
- PartySiteEO_setCurrentOverallPrimaryFlag
- PartySiteEO_setCurrentPrimaryFlag
- Update an address
- Address Locales
- Address Purposes
- Smart Actions
- Execute an action
- Generate smart actions
- Get a smart action - Not Supported
- Get action evaluation attributes - Not Supported
- Get all smart actions
- Get attributes - Not Supported
- Get entities - Not Supported
- Get mass or composite actions for the selected records
- Get object functions - Not Supported
- Process mass action - Not Supported
- Process mass or composite action
- Smart Action REST Path Parameter Definitions
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Aux Classifications
- Create a customer classification
- Delete a customer classification
- Get a customer classification
- Get all customer classifications
- Update a customer classification
- Smart Actions
- Execute an action
- Generate smart actions
- Get a smart action - Not Supported
- Get action evaluation attributes - Not Supported
- Get all smart actions
- Get attributes - Not Supported
- Get entities - Not Supported
- Get mass or composite actions for the selected records
- Get object functions - Not Supported
- Process mass action - Not Supported
- Process mass or composite action
- Smart Action REST Path Parameter Definitions
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Contact Points
- Create a contact point
- Delete a contact point
- Get a contact point
- Get all contact points
- Update a contact point
- Smart Actions
- Execute an action
- Generate smart actions
- Get a smart action - Not Supported
- Get action evaluation attributes - Not Supported
- Get all smart actions
- Get attributes - Not Supported
- Get entities - Not Supported
- Get mass or composite actions for the selected records
- Get object functions - Not Supported
- Process mass action - Not Supported
- Process mass or composite action
- Smart Action REST Path Parameter Definitions
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Notes
- Create a note
- Delete a note
- Get a note
- Get all notes
- Update a note
- Smart Actions
- Execute an action
- Generate smart actions
- Get a smart action - Not Supported
- Get action evaluation attributes - Not Supported
- Get all smart actions
- Get attributes - Not Supported
- Get entities - Not Supported
- Get mass or composite actions for the selected records
- Get object functions - Not Supported
- Process mass action - Not Supported
- Process mass or composite action
- Smart Action REST Path Parameter Definitions
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Large Object (LOB) Attributes - Note Text
- Orchestration Associations
- Organization Contacts
- Create an account contact
- Delete an account contact
- Get all account contacts
- Get an account contact
- OrganizationContactEO_setPreferredContactId
- Update an account contact
- Smart Actions
- Execute an action
- Generate smart actions
- Get a smart action - Not Supported
- Get action evaluation attributes - Not Supported
- Get all smart actions
- Get attributes - Not Supported
- Get entities - Not Supported
- Get mass or composite actions for the selected records
- Get object functions - Not Supported
- Process mass action - Not Supported
- Process mass or composite action
- Smart Action REST Path Parameter Definitions
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Primary Addresses
- Relationships
- Create a relationship
- Delete a relationship
- Get a relationship
- Get all relationships
- RelationshipEO_setPreferredContactId
- Update a relationship
- Smart Actions
- Execute an action
- Generate smart actions
- Get a smart action - Not Supported
- Get action evaluation attributes - Not Supported
- Get all smart actions
- Get attributes - Not Supported
- Get entities - Not Supported
- Get mass or composite actions for the selected records
- Get object functions - Not Supported
- Process mass action - Not Supported
- Process mass or composite action
- Smart Action REST Path Parameter Definitions
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Smart Actions
- Execute an action
- Generate smart actions
- Get a smart action - Not Supported
- Get action evaluation attributes - Not Supported
- Get all smart actions
- Get attributes - Not Supported
- Get entities - Not Supported
- Get mass or composite actions for the selected records
- Get object functions - Not Supported
- Process mass action - Not Supported
- Process mass or composite action
- Smart Action REST Path Parameter Definitions
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Source System References
- Large Object (LOB) Attributes - D&B Business Report
- Contacts
- Create a contact
- Delete a contact
- Find duplicates
- Get a contact
- Get all contacts
- PersonDEO_changeCustomerInPicker
- Update a contact
- Additional Identifiers
- Additional Names
- Attachments
- Aux Classifications
- Contact Addresses
- Create an address
- Delete an address
- Get all addresses
- Get an address
- PartySiteEO_setCurrentOverallPrimaryFlag
- PartySiteEO_setCurrentPrimaryFlag
- Update an address
- Address Locales
- Contact Address Purposes
- Smart Actions
- Execute an action
- Generate smart actions
- Get a smart action - Not Supported
- Get action evaluation attributes - Not Supported
- Get all smart actions
- Get attributes - Not Supported
- Get entities - Not Supported
- Get mass or composite actions for the selected records
- Get object functions - Not Supported
- Process mass action - Not Supported
- Process mass or composite action
- Smart Action REST Path Parameter Definitions
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Contact Attachments
- Contact Points
- Create a contact point
- Delete a contact point
- Get a contact point
- Get all contact points
- Update a contact point
- Smart Actions
- Execute an action
- Generate smart actions
- Get a smart action - Not Supported
- Get action evaluation attributes - Not Supported
- Get all smart actions
- Get attributes - Not Supported
- Get entities - Not Supported
- Get mass or composite actions for the selected records
- Get object functions - Not Supported
- Process mass action - Not Supported
- Process mass or composite action
- Smart Action REST Path Parameter Definitions
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Contact Primary Addresses
- Contact Rollups
- Notes
- Create a note
- Delete a note
- Get a note
- Get all notes
- Update a note
- Smart Actions
- Execute an action
- Generate smart actions
- Get a smart action - Not Supported
- Get action evaluation attributes - Not Supported
- Get all smart actions
- Get attributes - Not Supported
- Get entities - Not Supported
- Get mass or composite actions for the selected records
- Get object functions - Not Supported
- Process mass action - Not Supported
- Process mass or composite action
- Smart Action REST Path Parameter Definitions
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Large Object (LOB) Attributes - Note Text
- Relationships
- Create a relationship
- Delete a relationship
- Get a relationship
- Get all relationships
- RelationshipEO_setPreferredContactId
- Update a relationship
- Smart Actions
- Execute an action
- Generate smart actions
- Get a smart action - Not Supported
- Get action evaluation attributes - Not Supported
- Get all smart actions
- Get attributes - Not Supported
- Get entities - Not Supported
- Get mass or composite actions for the selected records
- Get object functions - Not Supported
- Process mass action - Not Supported
- Process mass or composite action
- Smart Action REST Path Parameter Definitions
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Sales Account Resources
- Create a sales team member
- Delete a sales team member
- Get a sales team member
- Get all sales team members
- Update a sales team member
- Smart Actions
- Execute an action
- Generate smart actions
- Get a smart action - Not Supported
- Get action evaluation attributes - Not Supported
- Get all smart actions
- Get attributes - Not Supported
- Get entities - Not Supported
- Get mass or composite actions for the selected records
- Get object functions - Not Supported
- Process mass action - Not Supported
- Process mass or composite action
- Smart Action REST Path Parameter Definitions
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Smart Actions
- Execute an action
- Generate smart actions
- Get a smart action - Not Supported
- Get action evaluation attributes - Not Supported
- Get all smart actions
- Get attributes - Not Supported
- Get entities - Not Supported
- Get mass or composite actions for the selected records
- Get object functions - Not Supported
- Process mass action - Not Supported
- Process mass or composite action
- Smart Action REST Path Parameter Definitions
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Source System References
- Households
- Create a household
- Delete a household
- Get a household
- Get all households
- Update a household
- Additional Identifiers
- Additional Names
- Addresses
- Create an address
- Delete an address
- Get all addresses
- Get an address
- PartySiteEO_setCurrentOverallPrimaryFlag
- PartySiteEO_setCurrentPrimaryFlag
- Update an address
- Address Locales
- Address Purposes
- Smart Actions
- Execute an action
- Generate smart actions
- Get action evaluation attributes - Not Supported
- Get all actions
- Get an action
- Get attributes - Not Supported
- Get entities - Not Supported
- Get mass or composite actions for the selected records
- Get object functions - Not Supported
- Process mass action - Not Supported
- Process mass or composite action
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Attachments
- Aux Classifications
- Contact Points
- Create a contact point
- Delete a contact point
- Get a contact point
- Get all contact points
- Update a contact point
- Smart Actions
- Execute an action
- Generate smart actions
- Get action evaluation attributes - Not Supported
- Get all actions
- Get an action
- Get attributes - Not Supported
- Get entities - Not Supported
- Get mass or composite actions for the selected records
- Get object functions - Not Supported
- Process mass action - Not Supported
- Process mass or composite action
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Household Contact
- Create a household contact
- Delete a household contact
- Get a household contact
- Get all household contacts
- Update a household contact
- Smart Actions
- Execute an action
- Generate smart actions
- Get action evaluation attributes - Not Supported
- Get all actions
- Get an action
- Get attributes - Not Supported
- Get entities - Not Supported
- Get mass or composite actions for the selected records
- Get object functions - Not Supported
- Process mass action - Not Supported
- Process mass or composite action
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Household Teams
- Notes
- Create a note
- Delete a note
- Get a note
- Get all notes
- Update a note
- Smart Actions
- Execute an action
- Generate smart actions
- Get action evaluation attributes - Not Supported
- Get all actions
- Get an action
- Get attributes - Not Supported
- Get entities - Not Supported
- Get mass or composite actions for the selected records
- Get object functions - Not Supported
- Process mass action - Not Supported
- Process mass or composite action
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Large Object (LOB) Attributes - Note Text
- Primary Addresses
- Relationships
- Create a relationship
- Delete a relationship
- Get a relationship
- Get all relationships
- RelationshipEO_setPreferredContactId
- Update a relationship
- Smart Actions
- Execute an action
- Generate smart actions
- Get action evaluation attributes - Not Supported
- Get all actions
- Get an action
- Get attributes - Not Supported
- Get entities - Not Supported
- Get mass or composite actions for the selected records
- Get object functions - Not Supported
- Process mass action - Not Supported
- Process mass or composite action
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Sales Account Resources
- Create a sales team member
- Delete a sales team member
- Get a sales team member
- Get all sales team members
- Update a sales team member
- Smart Actions
- Execute an action
- Generate smart actions
- Get action evaluation attributes - Not Supported
- Get all actions
- Get an action
- Get attributes - Not Supported
- Get entities - Not Supported
- Get mass or composite actions for the selected records
- Get object functions - Not Supported
- Process mass action - Not Supported
- Process mass or composite action
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Smart Actions
- Execute an action
- Generate smart actions
- Get action evaluation attributes - Not Supported
- Get all actions
- Get an action
- Get attributes - Not Supported
- Get entities - Not Supported
- Get mass or composite actions for the selected records
- Get object functions - Not Supported
- Process mass action - Not Supported
- Process mass or composite action
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Source System References
- Loyalty Member Promotion Enrollments
- Loyalty Members
- Create a loyalty member
- Get a loyalty member
- Get all loyalty members
- Merge members' detail
- Update a loyalty member
- Activities
- Cards
- Group Members
- Individual Members
- Member Attributes
- Member Contacts
- Member Referrals
- Member Tiers
- Member Transactions
- Point Balances
- Point Items
- Promotion Attribute Details
- Promotions
- Vouchers
- Loyalty Membership Cards
- Create a membership card collection for a member (Deprecated - See "Create a membership card" in the Loyalty Members resource)
- Get a loyalty membership card that is assigned to a member
- Get all loyalty membership cards that are assigned to a member
- Update a loyalty membership card that is assigned to a member (Deprecated - See "Update a membership card" in the Loyalty Members resource)
- Loyalty Products
- Loyalty Programs
- Get a loyalty program
- Get all loyalty programs
- Calendar Attributes
- Events
- Member Attributes
- Member Field Attributes
- Member Tier Attributes
- Negative Points
- Point Blocks
- Point Subtypes
- Point Total Attributes
- Point Types
- Program Partners
- Redemption Products
- Tier Classes
- Transaction Attributes
- Transaction Restrictions
- Loyalty Promotions
- Loyalty Transactions
- Loyalty Vouchers
- Partners
- Assign team and territory
- Create a partner
- Get a partner
- Get all partners
- PartySiteEO_setCurrentOverallPrimaryFlag
- PartySiteEO_setCurrentPrimaryFlag
- Update a partner
- Addresses
- Create an address
- Delete an address
- Get all addresses
- Get an address
- Update an address
- Smart Actions
- Execute an action
- Generate smart actions
- Get a smart action - Not Supported
- Get action evaluation attributes
- Get all smart actions
- Get attributes
- Get entities
- Get mass or composite actions for the selected records
- Get object functions
- Process mass action
- Process mass or composite action
- Smart Action REST Path Parameter Definitions
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Assessments
- Attachments
- Contact Points
- Create a contact point
- Delete a contact point
- Get a contact point
- Get all contact points
- Update a contact point
- Smart Actions
- Execute an action
- Generate smart actions
- Get a smart action - Not Supported
- Get action evaluation attributes
- Get all smart actions
- Get attributes
- Get entities
- Get mass or composite actions for the selected records
- Get object functions
- Process mass action
- Process mass or composite action
- Smart Action REST Path Parameter Definitions
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Expertises
- Focus Areas
- Geographies
- Industries
- Notes
- Create a note for a partner
- Delete a note for a partner
- Get a note for a partner
- Get all notes for a partner
- Update a note for a partner
- Smart Actions
- Execute an action
- Generate smart actions
- Get a smart action - Not Supported
- Get action evaluation attributes
- Get all smart actions
- Get attributes
- Get entities
- Get mass or composite actions for the selected records
- Get object functions
- Process mass action
- Process mass or composite action
- Smart Action REST Path Parameter Definitions
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Large Object (LOB) Attributes - Note Text
- Partner Account Team Members
- Create a partner account team member for a partner
- Delete a partner account team member for a partner
- Get a partner account team member for a partner
- Get all partner account team members for a partner
- Update a partner account team member for a partner
- Smart Actions
- Execute an action
- Generate smart actions
- Get a smart action - Not Supported
- Get action evaluation attributes
- Get all smart actions
- Get attributes
- Get entities
- Get mass or composite actions for the selected records
- Get object functions
- Process mass action
- Process mass or composite action
- Smart Action REST Path Parameter Definitions
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Partner Announcements
- Partner Certifications
- Partner Contacts
- Create a partner contact
- Delete a partner contact
- Get a partner contact
- Get all partner contacts
- Update a partner contact
- Attachments
- Smart Actions
- Execute an action
- Generate smart actions
- Get a smart action - Not Supported
- Get action evaluation attributes
- Get all smart actions
- Get attributes
- Get entities
- Get mass or composite actions for the selected records
- Get object functions
- Process mass action
- Process mass or composite action
- Smart Action REST Path Parameter Definitions
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- User Account Details
- Partner Rollups
- Partner Teams
- Partner Types
- Record Set Lookup
- Smart Actions
- Execute an action
- Generate smart actions
- Get a smart action - Not Supported
- Get action evaluation attributes
- Get all smart actions
- Get attributes
- Get entities
- Get mass or composite actions for the selected records
- Get object functions
- Process mass action
- Process mass or composite action
- Smart Action REST Path Parameter Definitions
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Large Object (LOB) Attributes - ActionIntent
- Product Groups
- Create a product group
- Delete a product group
- Get a product group by product group ID
- Get all product groups
- Get publish product group status
- Lock a product group for editing
- Publish all product groups
- Release lock on a product group
- Update a product group
- Attachments
- Filter Attributes
- Products
- Related Groups
- Subgroups
- Products
- Create a product
- Get a product
- Get all products
- Update a product
- Default Prices
- Product Attachments
- Product Image Attachments
- Product Translations
- Smart Actions
- Execute an action
- Generate smart actions
- Get action evaluation attributes - Not Supported
- Get all actions
- Get an action
- Get attributes - Not Supported
- Get entities - Not Supported
- Get mass or composite actions for the selected records
- Get object functions - Not Supported
- Process mass action - Not Supported
- Process mass or composite action
- Smart Action REST Payload Definitions
- Smart Action User Interface Definitions
- Create an action navigation definition
- Create an action REST path parameter
- Delete an action navigation definition
- Delete an action path parameter
- Get all action navigation definitions
- Get all action path parameters
- Get an action navigation definition
- Get an action path parameter
- Update an action navigation definition
- Update an action path parameter
- Large Object (LOB) Attributes - ActionIntent
- Large Object (LOB) Attributes - ExtendedDescriptionOne
- Large Object (LOB) Attributes - ExtendedDescriptionTwo
- Resources
- List of Values
- (Deprecated) Loyalty Products
- (Deprecated) Loyalty Programs
- Get a loyalty program (Deprecated)
- Get all loyalty programs (Deprecated)
- (Deprecated) Calendar Attributes
- (Deprecated) Member Attributes
- (Deprecated) Member Field Attributes
- (Deprecated) Point SubTypes
- (Deprecated) Point Totals Attributes
- (Deprecated) Point Types
- (Deprecated) Program Partners
- (Deprecated) Redemption Products
- (Deprecated) Tier Classes
- (Deprecated) Transaction Attributes
- (Deprecated) Loyalty Promotions
- Class Codes
- Currencies
- Languages
- Lookups
- Loy Events
- Loy PointTypes
- Name and ID Types
- Note Types
- Phone Country Codes
- Rated Currencies
- Relationship Types
- Standard Lookups List of Values
- Territories