Skip to content

Webclips

API to manage webclips for a tenant

Operations

Create webclip for a tenant

Request

Security
apiKey
Bodymultipart/form-datarequired
iconstring, (binary)

Icon of the webclip

labelstringrequired

Label of the web clip which is displayed on device

Example:"Example Label"
esper_namestringrequired

Name of the webclip in Esper

Example:"Example Name"
urlstringrequired

URL for the webclip

Example:"https://example.com"
target_bundle_idstringrequired

Target bundle ID for the webclip

Example:"com.example.bundle"
target_bundle_namestringrequired

Target bundle name for the webclip

Example:"Example Bundle"
is_full_screenbooleanrequired

Indicates if the webclip is full screen

Example:true
is_removablebooleanrequired

Indicates if the webclip is removable

Example:false
cURL
curl -i -X POST \
  https://develop-api.esper.io/_mock/openapi/v2/webclips \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: multipart/form-data' \
  -F icon=string \
  -F 'label=Example Label' \
  -F 'esper_name=Example Name' \
  -F url=https://example.com \
  -F target_bundle_id=com.example.bundle \
  -F 'target_bundle_name=Example Bundle' \
  -F is_full_screen=true \
  -F is_removable=false

Responses

Success

Bodyapplication/json
contentobject(Webclip)
Response
{
  "content": {
    "id": "09811f63-e2ca-4625-97c1-081145195d67",
    "tenant_id": "7d5fd1bf-bdf9-490b-9e32-203756a61235",
    "label": "Google",
    "url": "https://www.google.com/",
    "icon_url": null,
    "target_bundle_name": "Esper",
    "target_bundle_id": "com.esper.io",
    "is_full_screen": false,
    "is_removable": true,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "created_by": "string",
    "updated_by": "string"
  }
}