Tab Klip Instances

GET /tabs/{id}/klip-instances


Description	Get a list of the Klip instances associated with the tab in the company or client account.
Permissions	dashboard.tab
Resource URL	https://app.klipfolio.com/api/1.0/tabs/{id}/klip-instances
Parameters	tab id={id} optional: client_id

Example Request

GET https://app.klipfolio.com/api/1/tabs/fedcba9876543210fedcba9876543210/klip-instances

GET https://app.klipfolio.com/api/1/tabs/fedcba9876543210fedcba9876543210/klip-instances?client_id=0123456789abcdef0123456789abcdef

Example Response

{
 "data": {
  "klip_instances":
 [{
   "id":"04462abd3a38372173645f3b50128596",   
   "klip_id":"b2f4179cdc4f5a022a80310fe93b1022",
   "name":"Visits and Goals"
 }]
  },
 "meta": {
     "status": 200,
     "success": true
 }
}

PUT /tabs/{id}/klip-instances


Description	Add a Klip to a tab. The Klip id is used instead of the Klip instance id. Use in the company or client account. Note:* If region and position are not included, they default to 1 and 0 respectively.
Permissions	dashboard.tab
Resource URL	https://app.klipfolio.com/api/1.0/tabs/{id}/klip-instances
Fields	dashboard id optional: client_id

Example Request

PUT https://app.klipfolio.com/api/1/tabs/fedcba9876543210fedcba9876543210/klip-instances -d  {'klips': [{'klip_id': 'd012d123b56123d1234ef12c8f12c123', 'region': 0, 'position': 1}]}

PUT https://app.klipfolio.com/api/1/tabs/fedcba9876543210fedcba9876543210/klip-instances?client_id=0123456789abcdef0123456789abcdef -d  {'klips': [{'klip_id': 'd012d123b56123d1234ef12c8f12c123', 'region': 0, 'position': 1}]}

Example Response

{
  "meta": {
    "success": true,
    "status": 200
  },
  "data": {
    "klip_instances": [
      {
        "id": "12a123c123ef12333cbf7d3d864f674",
        "klip_id": "d012d123b56123d1234ef12c8f12c123",
        "name": "Klipfolio API, Client Dynamic, filter Active"
      }
    ]
  }
}

DELETE /tabs/{id}/klip-instances/


Description	Delete a Klip that is on a tab in the company or client account.
Permissions	dashboard.tab
Resource URL	`https://app.klipfolio.com/api/1.0/tabs/{id}/klip-instances/{id}`
Parameters	dashboard id klip instance id optional: client_id

Example Request

DELETE https://app.klipfolio.com/api/1/tabs/fedcba9876543210fedcba9876543210/klip-instances/c5t8i9abc4ca99613a1bd1bf5c123ce4

DELETE https://app.klipfolio.com/api/1/tabs/fedcba9876543210fedcba9876543210/klip-instances/c5t8i9abc4ca99613a1bd1bf5c123ce4?client_id=0123456789abcdef0123456789abcdef

Example Response

{
  "meta": {
    "success": true,
    "status": 200
  },
  "data": {}
}