Logo

Webclips

API to manage webclips for a tenant

Create webclip for a tenant

SecurityapiKey
Request
Request Body schema: multipart/form-data
required
icon
string <binary>

Icon of the webclip

label
required
string

Label of the web clip which is displayed on device

esper_name
required
string

Name of the webclip in Esper

url
required
string

URL for the webclip

target_bundle_id
required
string

Target bundle ID for the webclip

target_bundle_name
required
string

Target bundle name for the webclip

is_full_screen
required
boolean

Indicates if the webclip is full screen

is_removable
required
boolean

Indicates if the webclip is removable

Responses
200

Success

400

Bad Request

401

Unauthorized

409

Conflict

500

Internal Server Error

post/api/v2/webclips
Request samples 
Response samples 
application/json
{
  • "content": {
    }
}
Get webclips for a tenant
SecurityapiKey 
Request 
query Parameters
limit
number
 
offset
number
 
label
string
 
exact_esper_name
string
 
Responses 
200
Success


400
Bad Request


401
Unauthorized


500
Internal Server Error


get/api/v2/webclips
Request samples 
Response samples 
application/json
{
  • "content": {
    }
}
Get webclip by id for a tenant
SecurityapiKey 
Request 
path Parameters
webclipId
required
string <uuid> 
 
Responses 
200
Success


400
Bad Request


401
Unauthorized


404
Not Found


500
Internal Server Error


get/api/v2/webclips/{webclipId}
Request samples 
Response samples 
application/json
{
  • "content": {
    }
}
Delete webclip for a tenant
SecurityapiKey 
Request 
path Parameters
webclipId
required
string <uuid> 
 
Responses 
200
Success


400
Bad Request


401
Unauthorized


404
Not Found


409
Conflict


500
Internal Server Error


delete/api/v2/webclips/{webclipId}
Request samples 
Response samples 
application/json
{
  • "content": {
    }
}
➔ Next to Command Request