Jump to Content
Home
Guides
API Reference
v2.0
Log In
API Reference
Log In
v2.0
Home
Guides
API Reference
Connecting to the APIs
All
Pages
Start typing to search…
JUMP TO
Working with the NEON APIs
Connecting to the APIs
What API to use
General notes about Json bodies and responses
The NEON Loyalty API
The NEON Config API
The NEON Interact API
Working with the Loyalty API
Introduction
Query (GET) Endpoints
Pagination and Sorting
Filtering to limit query results
Querying by Member Lookup Id
Querying by Entity Lookup Id
Query Expressions
Save (POST) Endpoints
Response Payloads
Error Responses
Standard Fields
NEON Loyalty API
Activities
Query Activities
get
Save a new Activity
post
Save multiple Activities
post
Loyalty API Admin Support
Evalue a body-template
post
Evaluate a SQL template
post
Evaluate a value-expression
post
CMS
Get Cms content
get
Query CMS Document Resources
get
Codes
Query Code Set Resources
get
Pick a Code
post
Query Codes
get
View Code
get
Redeem a Code
post
Query Codes by Member
get
Competitions
Query Competition Resources
get
Query Competition entries
get
Submit or update an entry
post
Save multiple Entries
post
View Competition try
get
Query Competition Entries by Member
get
Custom events
Query Custom Resources
get
Submit a Custom event
post
Submit multiple Custom events
post
Tasks
Save an export Task to queue
post
Generate File URL
post
Save an import Task to queue
post
Generate File URL
get
Query Task queue
get
Save an import Task to queue
post
Abort Item Task
post
View Task errors
get
Forms
Query Form Resources
get
Query Form Members
get
Submit Form Member
post
Submit multiple Form Members
post
View Form Member
get
Funnels
Query Funnel Resources
get
Query Members
get
View Funnel Member
get
Query Steps
get
Save a Step
post
Save multiple Steps
post
Query Funnels by Member
get
Games
Query Game Resources
get
Query Highscores
get
Query Game plays
get
Save Game play
post
Submit multiple Game plays
post
View Game play
get
Query Games by Member
get
Journeys
Query Journey Resources
get
Query Journey Members
get
Start a Journey
post
Start multiple Journeys
post
View Journey Member
get
Query Journeys by Member
get
Lists
Query List resources
get
Clone a List
post
Manipulate a List from another List
post
Remove List Members
post
Set List column values
post
Copies Members into new Lists
post
Query List item
get
Save List Item
post
Save multiple List items
post
View List item
get
Query Lists by Member
get
Members
Query Members
get
Save a Member
post
Save multiple Members
post
View Member
get
Delete a Member
del
Messages
Query Messages by Member
get
Query Message Template Resources
get
Query Message Batches
get
Send a Message
post
Send multiple Messages
post
Query Messages
get
View Message
get
Offers
Query Offers by Member
get
Query Offer by Member
get
Query Offer Resources
get
Claim an Offer
post
Query Offer instances
get
Orders
Query Orders by Member
get
Query Payments by Member
get
Query Order Lines
get
Query Orders
get
Save Order
post
View Order
get
Query Payments
get
Save Payment
post
Relationships
Query Relationships by Member
get
Query Relationship Resources
get
Query Relationships
get
Save Relationship
post
Save multiple Relationships
post
Sheets
Query Sheets by Member
get
Query Sheet Resources
get
Query Sheet rows
get
Save Sheet Row
post
Save multiple Rows
post
View Sheet Row
get
Surveys
Query Surveys by Member
get
Query Survey Resources
get
Query Survey entries
get
Submit Survey
post
Submit multiple Surveys
post
View Survey entry
get
Votes
Query Votes by Member
get
Query Vote Resources
get
Query Vote entries
get
Submit Vote
post
Submit multiple Votes
post
View Vote entry
get
Wallets
Query Wallets by Member
get
Save Wallet Transaction
post
Submit multiple Transactions
post
Query Wallets
get
View Wallet
get
Query Wallet transactions
get
Reporting
Database Table Definition Report
get
Database Table Size Report
get
Dimension Combinations Report
get
Dimension combination Entities Report
get
Dimension Values Report
get
Dimension Value Entities Report
get
Entity Stats Report
get
Entity Stats Trend Report
get
Target Expressions
Parses/Validates an Expression
post
Process an Expression
post
Export Target Expression Members
get
Modify a Tag List based on a Target
post
Resets an INVALID step
post
NEON Interact API
Events
Log an event
post
Links
Track and Redirect a Link
get
NEON Config API
Welcome to the Config API
Entity Config
Query Entities
get
Add Entity
post
Bulk load Entities
post
List field values
get
View Entity
get
Patch Entity
patch
Update Entity
put
Query Entity references
get
CMS Content Config
Query CMS Content
get
Save CMS Content
post
Delete CMS Content
del
CMS Definition Config
Query CMS Definitions
get
Add CMS Definition
post
Delete CMS Definition
del
View CMS Definition
get
Patch CMS Definition
patch
Update CMS Definition
put
CMS Document Config
Query CMS Documents
get
Add CMS Document
post
Delete CMS Document
del
View CMS Document
get
Patch CMS Document
patch
Update CMS Document
put
Code Bank Config
Query Code Banks
get
Add Code Bank
post
Delete Code Bank
del
View Code Bank
get
Patch Code Bank
patch
Update Code Bank
put
Code Bank Administration
Query Code Batches
get
Query Code Bank Codes
get
View Code Bank Code
get
Code Set Config
Query Code Sets
get
Add Code Set
post
Delete Code Set
del
View Code Set
get
Patch Code Set
patch
Update Code Set
put
Code Set Administration
Query Code Set Codes
get
Add multiple Code Set Codes
post
Competition Config
Query Competitions
get
Add Competition
post
Delete Competition
del
View Competition
get
Patch Competition
patch
Update Competition
put
Custom Entities Config
Query Custom Entities
get
Add Custom Entity
post
Delete Custom Entity
del
View Custom Entity
get
Patch Custom Entity
patch
Update Custom Entity
put
Dimension Config
Query Dimensions
get
Add Dimension
post
Query Dimension Values
get
Add Dimension Value
post
Delete Dimension Value
del
View Dimension Value
get
Update Dimension Value
put
Delete Dimension
del
View Dimension
get
Patch Dimension
patch
Update Dimension
put
Form Config
Query Forms
get
Add Form
post
Delete Form
del
View Form
get
Patch Form
patch
Update Form
put
Funnel Config
Query Funnels
get
Add Funnel
post
Delete Funnel
del
View Funnel
get
Patch Funnel
patch
Update Funnel
put
Game Config
Query Games
get
Add Game
post
Delete Game
del
View Game
get
Patch Game
patch
Update Game
put
Interact Keys
List Interact Key
get
Generate Interact Key
post
Delete Interact Key
del
Update Interact Key
post
Job Config
Query Jobs
get
Add Job
post
Delete Job
del
View Job
get
Patch Job
patch
Update Job
put
Job Administration
Disable Job
post
Query Job Logs
get
Reset Job
post
Run the Job Now
post
Journey Config
Query Journeys
get
Add Journey
post
Delete Journey
del
View Journey
get
Patch Journey
patch
Update Journey
put
List Config
Query Lists
get
Add List
post
Delete List
del
View List
get
Patch List
patch
Update List
put
Member Config
Get Member configuration
get
Patch Member configuration
patch
Update Member configuration
put
Message Config
Query Message Servers
get
Add Message Server
post
Delete Message Server
del
View Message Server
get
Patch Message Server
patch
Update Message Server
put
Query Message Templates
get
Add Message Template
post
Delete Message Template
del
View Message Template
get
Patch Message Template
patch
Update Message Template
put
Offer Config
Query Offers
get
Add Offer
post
Delete Offer
del
View Offer
get
Patch Offer
patch
Update Offer
put
Order Set Config
Query Order Sets
get
Add Order Set
post
Delete Order Set
del
View Order Set
get
Patch Order Set
patch
Update Order Set
put
Relationship Config
Query Relationships
get
Add Relationship
post
Delete Relationship
del
View Relationship
get
Patch Relationship
patch
Update Relationship
put
Settings Config
Query Settings
get
Add Settings
post
Delete Settings
del
View Settings
get
Patch Settings
patch
Update Settings
put
Sheet Config
Query Sheets
get
Add Sheet
post
Delete Sheet
del
View Sheet
get
Patch Sheet
patch
Update Sheet
put
Query Property Sheet Properties
get
Add Property Sheet Property
post
Delete Property Sheet Property
del
View Property Sheet Property
get
Update Property Sheet Property
put
Survey Config
Query Surveys
get
Add Survey
post
Delete Survey
del
View Survey
get
Patch Survey
patch
Update Survey
put
User Role Config
Query User Roles
get
Add User Role
post
Delete User Role
del
View User Role
get
Patch User Role
patch
Update User Role
put
User Administration
Query Users
get
Create User
post
List assignable Users
get
View User
get
Update User
post
Change my password
post
User Authentication
Authenticate credentials
post
Query a User's access keys
get
Edit an access key
post
Generate a new access key
post
Revoke an access key
post
Vote Config
Query Votes
get
Add Vote
post
Delete Vote
del
View Vote
get
Patch Vote
patch
Update Vote
put
Wallet Config
Query Wallets
get
Add Wallet
post
Delete Wallet
del
View Wallet
get
Patch Wallet
patch
Update Wallet
put
Powered by
Connecting to the APIs
Ask AI
