For AI agents: visit https://docs.extole.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
My Extole Login
Github
Home
Documentation
API Reference
Recent Releases
Newsletters
My Extole Login
Github
Log In
API Reference
Search
Log In
Home
Documentation
API Reference
Recent Releases
Newsletters
Create an erasure request
JUMP TO
Getting Started
API Overview
Authentication
Errors
Integration API - Server to Extole
Authentication
Get current access token
get
Get access token by value
get
Create access token
post
Exchange access token
put
Invalidate access token
del
Batch Jobs
List batch jobs
get
Get a batch job
get
Create a batch job
post
Cancel a batch job
post
Expire a batch job
post
Update a batch job
put
Delete a batch job
del
Events
Submit an event asynchronously
post
Submit a named event asynchronously
post
Submit an event
post
Submit a named event
post
Files
List file assets
get
Get a file asset
get
Download a file asset
get
Upload a file asset
post
Expire a file asset
post
Update a file asset
put
Delete a file asset
del
Persons
Search for persons
get
List partner keys
get
Get person block status
get
List person data parameters
get
Get a person data parameter
get
Get identity history for a person
get
List person journeys
get
Get a person journey
get
List person locations
get
List person audience memberships
get
List person relationships
get
List person rewards
get
Get a person reward
get
List person shareables
get
Get a person shareable
get
List person shares
get
Get a person share
get
List person steps
get
Create a person
post
Create a person data parameter
post
Forward an identity profile to another identity profile
post
Create a person audience membership
post
Create a person shareable
post
Update a person
put
Update person block status
put
Update a person data parameter
put
Update a person shareable
put
Delete a person data parameter
del
Delete a person audience membership
del
Get a person
get
Rewards
List rewards
get
Get reward state summary
get
Get a reward
get
Get reward cancels
get
Get reward fails
get
Get reward fulfillments
get
Get reward state history
get
Get reward redeems
get
Get reward revokes
get
Get reward sends
get
Mark custom reward failed
post
Mark custom reward fulfilled
post
Mark custom reward fulfilled and sent
post
Mark custom reward redeemed
post
Mark custom reward sent
post
Cancel a reward
post
Retry a reward
post
Revoke a reward
post
Update a reward
put
Get reward expirations
get
Expire a reward
post
SFTP Servers
List SFTP destinations
get
Get an SFTP destination
get
Create an SFTP destination
post
Sync an SFTP destination
post
Validate an SFTP destination
post
Update an SFTP destination
put
Delete an SFTP destination
del
Content
Fetch a rendered zone
get
Render a zone with the name in the body
post
Render a zone with targeting data
post
Integration API - Consumer to Extole
Authentication
Get consumer token details
get
Create a consumer access token
post
Delete a consumer access token
del
Content
Render a zone
post
Render a named zone
post
Render a zone with the name in the body
post
Render a named zone for web-page embedding
post
Profiles
Get share event status
get
Get the authenticated consumer profile
get
List advocate relationships
get
List assets for the authenticated consumer
get
Download an asset by name
get
Get an asset by ID
get
Download an asset by ID
get
List audience memberships
get
Get email send status
get
List friends for the authenticated consumer
get
List journeys for the authenticated consumer
get
Get profile parameters for the authenticated consumer
get
List referrals from the authenticated consumer
get
List referrals to the authenticated consumer
get
Get reward redemption status
get
Get verification email status
get
List shareables for the authenticated consumer (legacy)
get
Get shareable creation status (legacy)
get
Get a shareable by ID (legacy)
get
List shares for the authenticated consumer
get
Get a share by ID
get
List steps for the authenticated consumer
get
List assets for a person
get
Download a person asset by name
get
Get a person asset by ID
get
Download a person asset by asset ID
get
Look up shareables by code (legacy)
get
Get shareable creation status (legacy)
get
Get a shareable by ID (legacy)
get
List shares
get
Get a share by ID
get
Get custom share status
get
List shareables for the authenticated consumer
get
Get a shareable by code
get
Submit a share event
post
Update the authenticated consumer profile
post
Create an asset for the authenticated consumer
post
Send an email as the authenticated consumer
