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
Delete a block
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
post
Update multiple profile parameters
post
Send a profile verification email
post
Create a shareable (legacy)
post
Create a shareable (legacy)
post
Submit a custom share event
post
Send referral email shares in batch (legacy)
post
Create a shareable for the authenticated consumer
post
Get, create, or update a shareable
post
Get or create a shareable
post
Set a single profile parameter
put
Update a shareable (legacy)
put
Delete an asset by ID
del
Events
Submit a consumer event by URL
get
Persons
Get a person's profile picture URL (legacy)
get
Get a public person profile (legacy)
get
Management API
Audiences
List audiences
get
List built audiences
get
Get audience
get
Get built audience
get
List audience member IDs
get
Download audience members
get
List audience members
get
List audience operations
get
Get an audience operation
get
Get audience operation state
get
Get audience operation debug state
get
Get audience operation with details
get
Get audience membership statistics
get
Create audience
post
Delete audience
post
Create an audience operation
post
Cancel an audience operation
post
Retry an audience operation
post
Unarchive audience
post
Update audience
put
Archive audience
del
Authentication
List managed access tokens
get
Create a managed access token
post
Delete a managed access token
del
Debug consumer access token
get
Batch Jobs
List job execution history
get
Get a job execution history entry
get
Blocks
List blocks
get
List global blocks
get
Get a block
get
Create a block
post
Test a block
post
Delete a block
del
Campaigns
List campaign summaries
get
Get a campaign summary
get
List campaigns
get
List built campaigns
get
List deleted campaigns
get
List duplicatable campaigns
get
List campaign versions
get
Get a campaign version
get
Get a campaign
get
Get a built campaign
get
Download a campaign bundle
get
Upload a new campaign from archive
post
Rename a campaigns program label
post
Archive a campaign
post
Discard a campaign draft
post
Duplicate a campaign
post
End a campaign
post
Launch a campaign in burst mode
post
Launch a campaign in test mode
post
Set a campaign live
post
Lock a campaign
post
Make a campaign version the latest draft
post
Make a campaign version latest while preserving state
post
Make a campaign version the latest published
post
Pause a campaign
post
Publish a campaign
post
Schedule a campaign state change
post
Stop a campaign
post
Unarchive a campaign
post
Undelete a campaign
post
Unlock a campaign
post
Update campaigns by program label
put
Update a campaign from archive
put
Delete a campaign
del
Components
List components
get
List built components
get
Get available component upgrades
get
Diff two components
get
Download translatable component variables
get
List duplicatable components
get
List built duplicatable components
get
List component assets
get
List built component assets
get
Get a component asset
get
Get a built component asset
get
Get component asset content
get
List component settings
get
List built component settings
get
Get a component setting
get
Get a built component setting
get
List installed components in setting
get
Get a component
get
Get a built component
get
Get component anchors
get
Upload a component bundle
post
Upgrade a component
post
Create a component asset
post
Create a component setting
post
Add component to setting
post
Remove component from setting
post
Duplicate a component
post
Upload translatable component variables
put
Update a component asset
put
Batch update component settings
put
Update a component setting
put
Delete a component asset
del
Delete a component setting
del
Delete a component
del
Domains
List client domains
get
Get client domain
get
Get client domain with decrypted SSL private key
get
Create client domain
post
Validate client domain
post
Update client domain
put
Archive client domain
del
Email
List email domains
get
Get an email domain
get
Validate an email domain
get
Create an email domain
post
Update an email domain
put
Delete an email domain
del
Erasure
Create an erasure request
post
Event Streams
List event streams
get
List built event streams
get
Get an event stream
get
Get a built event stream
get
List events from an event stream
get
List event stream filters
get
Get an event stream filter
get
Create an event stream
post
Delete an event stream
post
Create an event stream filter
post
Unarchive an event stream
post
Update an event stream
put
Update an event stream filter
put
Archive an event stream
del
Archive an event stream filter
del
File Validation Monitors
List jobs
get
Create a job
post
Get a job
get
Update a job
put
Delete a job
del
List tasks
get
Add a task
post
Get a task
get
Update a task
put
Delete a task
del
List triggers
get
Add a trigger
post
Get a trigger
get
Update a trigger
put
Delete a trigger
del
Optout
Get opt-out status
get
Profiles
Get a shareable link
get
Promotion Links
List promotion links
get
Get a promotion link
get
Create a promotion link
post
Report Schedules
List report runners
get
List report runner templates
get
Get a report runner
get
Create a report runner
post
Duplicate a report runner
post
Update a report runner
put
Delete a report runner
del
