Jump to Content
Dashboard
iOS
Android
A8 Media Player
Consumer API
Management API
Home
Guides
API Reference
Changelog
Discussions
v1.2
SDK
Self-Serve
Dashboard
iOS
Android
A8 Media Player
Consumer API
Management API
Log In
API Reference
Log In
v1.2
API Reference
/beacon
All
Pages
Start typing to search…
These docs are for v1.2. Click to read the latest docs for v1.3.
JUMP TO
ACTV8 API v4.4 - Official Documentation
activity
/activity
get
admin
/admin
get
/admin
post
/admin/{id}
put
/admin/{id}/client/{client_id}/invite
post
/admin/validate
get
/admin/login
post
/admin/{id}/logout
post
/admin/password/forgot
post
/admin/password/verify
get
/admin/password/reset
post
/admin/regenerateMfaToken
post
/admin/{id}/profile
get
/admin/{id}/profile
put
/admin/{id}/role
get
/admin/{id}/role/{role_id}
post
/admin/{id}/role/{role_id}
del
/admin/{id}/permission
get
/admin/{id}/permission/{permission_id}
post
/admin/{id}/permission/{permission_id}
del
/admin/{id}/client
get
/admin/{id}/pii
get
/admin/{id}/pii
put
oauth
/oauth/token
post
androidpass
/androidpass
get
/androidpass/{id}
get
applepass
/applepass
get
/applepass/{id}
get
application
/application
get
/application
post
/application/{id}
get
/application/{id}
put
/application/{id}
del
/application/{id}/api-key
get
/application/{id}/api-key
post
/application/{id}/api-key/{api_key_id}
put
/application/{id}/api-key/{api_key_id}
del
/application/{id}/trigger/{trigger_id}
post
/application/{id}/trigger/{trigger_id}
del
/application/{id}/trigger
get
/application/{id}/impressions
get
/application/{id}/restore
put
/application/{id}/user
get
/application/{id}/user/{user_id}/profile
get
/application/{application_id}/user/{user_id}
del
/application/{id}/user/{user_id}/impressions
get
/application/{id}/user/{user_id}/content
get
/application/{id}/user/{user_id}/device
get
/application/{id}/user/{user_id}/claims
get
/application/{id}/user/{user_id}/scratcher-set/{scratcher_set_id}
get
/application/{id}/user/{user_id}/scratcher-set/{scratcher_set_id}
put
/application/{id}/asset/{asset_id}
post
campaign
/campaign/{id}/impressions/new-users
get
/campaign
get
/campaign
post
/campaign/{id}
get
/campaign/{id}
put
/campaign/{id}
del
/campaign/{id}/trigger
get
/campaign/{id}/trigger/{trigger_id}
put
/campaign/{id}/trigger/{trigger_id}
del
/campaign/{id}/trigger/{trigger_id}/activate
put
/campaign/{id}/trigger/{trigger_id}/deactivate
put
/campaign/{id}/target/{target_id}
put
/campaign/{id}/target/{target_id}
del
/campaign/{id}/impressions
get
asset
/asset
get
/asset
post
/asset/{id}
get
/asset/{id}
put
/asset/{id}
del
/asset/{id}/contents
get
/asset/{id}/applications
get
/asset/{id}/storycards
get
/asset/{id}/relations
get
/asset/{id}/tags/
post
/asset/{id}/tags/
del
asset-type
/asset-type
get
/asset-type
post
/asset-type/{id}
get
/asset-type/{id}
put
/asset-type/{id}
del
audio
/audio
get
/audio/{id}
get
/audio/{id}
put
/audio/{id}
del
/watermark
post
/fingerprint
post
/audio/{id}/activate
post
/audio/{id}/deactivate
put
/audio/{id}/application/{application_id}
put
/audio/{id}/application/{application_id}
del
/audio/{id}/client/{client_id}
post
/audio/{id}/client/{client_id}
del
/audio/{external_id}/catch
post
beacon
/beacon
get
/beacon
post
/beacon/{id}
get
/beacon/{id}
put
/beacon/{id}
del
/beacon/synchronize
get
/beacon/synchronize
put
/beacon/{id}/synchronize
put
/beacon/{id}/activate
put
/beacon/{id}/deactivate
put
/beacon/{id}/client/{client_id}
post
/beacon/{id}/client/{client_id}
del
/beacon/{eddystone_instance_id}/catch
post
brand
/brand
get
/brand
post
/brand/{id}
get
/brand/{id}
put
/brand/{id}
del
/brand/{id}/point-of-interest/{poi_id}
post
/brand/{id}/point-of-interest/{poi_id}
del
/brand/{id}/point-of-interest
get
button
/button/key
get
/button/key
post
/button/label
get
/button/label
post
/button/key/{id}
get
/button/key/{id}
put
/button/key/{id}
del
/button/label/{id}
get
/button/label/{id}
put
/button/label/{id}
del
category
/category
get
/category
post
/category/{id}
get
/category/{id}
put
/category/{id}
del
/category/{id}/content
get
claim
/claim
get
/claim
post
/claim/{id}
get
/claim/{id}
put
/claim/{id}
del
/claim/{id}/process
post
client
/client
post
/client/{id}
get
/client/{id}
put
/client/{id}
del
/client/{id}/admin
get
/client/{id}/role
get
/client/{id}/application
get
/client/{client_id}/module/{module_id}
post
/client/{client_id}/module/{module_id}
del
/client/{id}/assets
get
/client/{id}/add-assets
post
/client/{id}/impressions
get
content
/content
get
/content
post
/content/{id}
get
/content/{id}
put
/content/{id}
del
/content/{id}/asset/{asset_id}
post
/content/{id}/target/{target_id}
post
/content/{id}/category/{category_id}
post
/content/{id}/category/{category_id}
del
/content/{id}/tag/{tag_id}
post
/content/{id}/tag/{tag_id}
del
/content/{id}/tags/
post
/content/{id}/tags/
del
/content/{id}/buttons
post
/content/{id}/buttons
del
/content/{content_id}/application/{application_id}/passstatus
get
/content/{content_id}/application/{application_id}/passstatus
post
/content/{id}/impressions
get
content-terms
/content-terms
get
/content-terms
post
/content-terms/{id}
get
/content-terms/{id}
put
/content-terms/{id}
del
content-url
/content-url
get
/content-url
post
/content-url/{id}
get
/content-url/{id}
put
/content-url/{id}
del
country-state
/country-state/countries
get
/country-state/country/{countrycode}
get
/country-state/country/{countrycode}/states
get
delivery-preset
/delivery-preset
get
/delivery-preset
post
/delivery-preset/{id}
get
/delivery-preset/{id}
put
/delivery-preset/{id}
del
/delivery-preset/{id}/content-group
get
/delivery-preset/{id}/replicate
post
/delivery-preset/{id}/triggers
get
device
/device
get
/device
post
/device/{uuid}
get
/device/{uuid}
put
/device/{uuid}
del
/device/{uuid}/content
get
/device/{uuid}/content
del
/device/{uuid}/content/{content_id}
get
/device/{uuid}/content/{content_id}
put
/device/{uuid}/content/{content_id}
del
/device/{id}/content/{content_id}/androidpass
get
/device/{id}/content/{content_id}/androidpass
post
/device/{id}/content/{content_id}/applepass
get
/device/{id}/content/{content_id}/applepass
post
user
/user
get
/user
post
/user/{id}
put
/user/{id}
del
/user/validate
get
/user/password/forgot
post
/user/password/verify
get
/user/password/reset
post
/user/login
post
/user/token/refresh
post
/user/logout
post
/user/regenerateMfaToken
post
/user/{id}/deactivate
put
/user/{id}/content/{content_id}
get
/user/{id}/content/{content_id}
put
/user/{id}/content/{content_id}
post
/user/{id}/content/{content_id}
del
/user/{id}/content
get
/user/{id}/content
del
/user/{id}/scratcher-set
get
/user/{id}/scratcher-set/catch
post
/user/{id}/scratcher-set/reset
put
/user/{id}/scratcher-set/share
put
/user/{id}/reset
put
/user/{id}/category/{category_id}
post
/user/{id}/category/{category_id}
del
/user/{id}/categories/
post
/user/{id}/categories/
del
/user/{id}/categories
get
/user/{id}/tag/{tag_id}
post
/user/{id}/tag/{tag_id}
del
/user/{id}/tags/
post
/user/{id}/tags/
del
/user/{id}/tags
get
/user/{id}/content/{content_id}/androidpass
get
/user/{id}/content/{content_id}/androidpass
post
/user/{id}/content/{content_id}/applepass
get
/user/{id}/content/{content_id}/applepass
post
/user/{id}/pii
get
/user/{id}/pii
put
/user/{id}/pii
del
/user/{id}/pii/device
get
/user/{id}/activity
get
/user/{id}/pii/download
get
/user/{id}/pii/request
get
analytics
/event
post
geofence
/geofence
get
/geofence
post
/geofence/{id}
get
/geofence/{id}
put
/geofence/{id}
del
/geofence/{id}/client/{client_id}
post
/geofence/{id}/client/{client_id}
del
/geofence/{external_id}/catch
post
/geofence/nearby
get
content-group
/content-group
get
/content-group
post
/content-group/{id}
get
/content-group/{id}
put
/content-group/{id}
del
/content-group/{id}/content/{content_id}
post
/content-group/{id}/content/{content_id}
del
/content-group/{id}/content
get
/content-group/{id}/target/{target_id}
post
/content-group/{id}/target/{target_id}
del
/content-group/{id}/target
get
/content-group/{id}/region/{region_id}
post
/content-group/{id}/region/{region_id}
del
/content-group/{id}/region
get
/content-group/{id}/timemarks
get
/content-group/{id}/timemark/{timemark_id}
post
/content-group/{id}/timemark/{timemark_id}
del
/content-group/{id}/category/{category_id}
post
/content-group/{id}/category/{category_id}
del
/content-group/{id}/tag/{tag_id}
post
/content-group/{id}/tag/{tag_id}
del
hyperlink
Returns all Hyperlink instances
get
Creates new Hyperlink instance
post
Returns Hyperlink instance by id
get
Updates a Hyperlink instance
put
Deletes Hyperlink instance
del
Delivers content (if available) using the Instance ID of a Hyperlink trigger
post
media
/media
get
/media
post
/media/{id}
get
/media/{id}
put
/media/{id}
del
/media/{id}/timemark
post
/media/{identifier}/timemarks
get
/media/{id}/timemark/{timemark_id}
put
/media/{media_id}/timemark/{timemark_id}
del
/media/{identifier}/catch
post
module
/module
get
/module
post
/module/{id}
get
/module/{id}
put
/module/{id}
del
permission
/permission
get
pointofinterest
/point-of-interest
get
/point-of-interest
post
/point-of-interest/{id}
get
/point-of-interest/{id}
put
/point-of-interest/{id}
del
prize
/prize
get
/prize
post
/prize/{id}
get
/prize/{id}
put
/prize/{id}
del
/prize/winners
get
push-notification
/push-notification/message
get
/push-notification/message
post
/push-notification/message/{id}
get
/push-notification/message/{id}
put
/push-notification/message/{id}
del
/push-notification/message/{id}/send
post
/push-notification/token
get
/push-notification/token
post
/push-notification/token
del
qrcode
/qrcode
get
/qrcode
post
/qrcode/{id}
get
/qrcode/{id}
put
/qrcode/{id}
del
/qrcode/{id}/catch
post
redeem-codes
/redeem-codes
get
/redeem-codes/{id}
get
/redeem-codes/burn
post
region
/region
get
/region
post
/region/{id}
get
/region/{id}
put
/region/{id}
del
/region/{id}/geofence/{geofence_id}
post
/region/{id}/geofence/{geofence_id}
del
/region/{id}/geofence
get
/region/{id}/state/{statecode}
post
/region/{id}/state/{statecode}
del
/region/{id}/states
get
retailer
/retailer
get
/retailer
post
/retailer/{id}
get
/retailer/{id}
put
/retailer/{id}
del
/retailer/{id}/pointsofinterest/{poi_id}
post
/retailer/{id}/pointsofinterest/{poi_id}
del
/retailer/{id}/pointsofinterest
get
role
/role
get
/role
post
/role/{id}
get
/role/{id}
put
/role/{id}
del
/role/{id}/permission
get
/role/{id}/permission/{permission_id}
post
/role/{id}/permission/{permission_id}
del
scratcher-set
/scratcher-set
get
/scratcher-set
post
/scratcher-set/{id}
get
/scratcher-set/{id}
put
/scratcher-set/{id}
del
/scratcher-set/{id}/sequence
get
/scratcher-set/{id}/sequence
post
/scratcher-set/prize-rules
get
/scratcher-set/{id}/sequence/{sequence_id}
get
/scratcher-set/{id}/sequence/{sequence_id}
put
/scratcher-set/{id}/sequence/{sequence_id}
del
/scratcher-set/{id}/impressions
get
/scratcher-set/{id}/prize-rules
get
shortlink
/shortlink
get
/shortlink
post
/shortlink/{id}
get
/shortlink/{id}
put
/shortlink/{id}
del
/shortlink/{id}/events
get
storycard
/storycard
get
/storycard
post
/storycard/{id}
get
/storycard/{id}
put
/storycard/{id}
del
/storycard/active
get
/storycard/active
put
/storycard/id/impression
post
/storycard/{id}/asset/{asset_id}
post
tag
/tag
get
/tag
post
/tag/{id}
get
/tag/{id}
put
/tag/{id}
del
target
/target
get
/target
post
/target/{id}
get
/target/{id}
put
/target/{id}
del
timemark
/timemark
get
touch
/touch
get
/touch
post
/touch/{id}
get
/touch/{id}
put
/touch/{id}
del
/touch/{id}/client/{client_id}
post
/touch/{id}/client/{client_id}
del
trigger
/trigger
get
/trigger
post
/trigger/{id}
get
/trigger/{id}
put
/trigger/{id}
del
/trigger/{id}/impressions
get
/trigger/{trigger_id}/application/{application_id}
post
/trigger/{trigger_id}/application/{application_id}
del
/trigger/{id}/tags/
post
/trigger/{id}/tags/
del
trigger-group
/trigger-group
get
/trigger-group
post
/trigger-group/{id}
get
/trigger-group/{id}
put
/trigger-group/{id}
del
/trigger-group/{id}/trigger
get
Powered by
/beacon
Ask AI
post
https://devpartners.actv8technologies.com/beacon
Creates a new beacon instance
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header +2
URL
Base URL
https://devpartners.actv8technologies.com
/beacon
Response
Click
Try It!
to start a request and see the response here!