Post
Create a new document hotspot
Parameters:
Name
Optional / Required
Data type
Description
Default
document_id
required
Integer
One of your document ids
page
required
String
Page number (1-X)
type
required
String
Type can be link, video, audio or slideshow
settings[x]
required
Integer
x position of the document hotspot
settings[y]
required
Integer
y position of the document hotspot
settings[w]
required
Integer
width of the document hotspot
settings[h]
required
Integer
height of the document hotspot
settings[name]
required
String
a name for the document hotspot (min. length 5, max. length 50)
settings[tooltip]
required
String
a tooltip for the document hotspot (min. length 5, max. length 50)
settings[link]
optional
String
a url (valid URL)
settings[source]
optional
String
youtube, vimeo, flickr, soundcloud, yumpu
settings[source_id]
optional
String
youtube: a valid youtube video id vimeo: a valid vimeo video id flickr: a valid flickr id
settings[source_ids]
optional
String
One or multiple media ids separated by a comma (example: GlKIWjJyWtg2XFKi,tFtOzlqZyqeaNkfw)
settings[source_url]
optional
String
soundcloud: a valid soundcloud url
settings[autoplay]
optional
String
y or n
settings[show_arrows]
optional
String
y or n
settings[show_headline]
optional
String
y or n
settings[object_fit]
optional
String
y or n
settings[background_opacity]
optional
String
0 to 1
settings[background_color]
optional
String
Hexadecimal value, 6 characters.
000000 - FFFFFF
settings[hideborder]
optional
String
y or n
settings[asarea]
optional
String
y or n
Demo
URL Find your token on - yumpu.com Token
document_id page type settings[x] settings[y] settings[w] settings[h] settings[name] settings[tooltip]
Optional parameters:
settings[link] settings[source] settings[source_id] settings[source_ids] settings[source_url] settings[autoplay]
Add optional parametersRun request
Example:
Whatever language you are using, the result will be the same.
Last updated