GET /klips/{id}/share-rights

Description

Get a list of share rights for the specified Klip.

Permissions

dashboard.library

Resource URL

https://app.klipfolio.com/api/1.0/klips/{id}/share-rights

Parameters

None.

Example Request

GET https://app.klipfolio.com/api/1/klips/ec6947ab9d07fdd6b9bb41551c79fd31/share-rights

Example Response

{
   "data": {
       "share_rights": []
   },
   "meta": {
       "status": 200,
       "success": true
   }
}

PUT /klips/{id}/share-rights

Description

Update the share rights for the specified Klip. If the Klip is not already shared with the specified group, a new share-right is created, otherwise the existing share-right is updated.

Permissions

klip.share

Resource URL

https://app.klipfolio.com/api/1.0/klips/{id}/share-rights

Fields

groups

Example Request

PUT https://app.klipfolio.com/api/1/klips/ec6947ab9d07fdd6b9bb41551c79fd31/share-rights -d 
“{
 'groups': [
     {
       ‘group_id’:’0123456789abcdef0123456789abcdef’,
      ‘can_edit’:true
     }
  ]
}”

Example Response

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

DELETE /klips/{id}/share-rights

Description

Delete a group’s share rights for the specified Klip.

Permissions

klip.share

Resource URL

https://app.klipfolio.com/api/1.0/klips/{id}/share-rights

Parameters

None.

Example Request

DELETE https://app.klipfolio.com/api/1/klips/ec6947ab9d07fdd6b9bb41551c79fd31/share-rights -d 
“{
 'groups': [
     {‘group_id’:’0123456789abcdef0123456789abcdef’,
      ‘can_edit’:true}
  ]
}”

Example Response

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

POST /klips/{id}/@/import

Description
Permissions
Resource URL
Fields
Response codes

Import the specified klip and its associated data sources into the specified client account. The location of the imported klip is returned on successful completion.
klip.import
https://app.klipfolio.com/api/1.0/klips/{id}/@/import
None.
400 — missing client_id
401 — access denied to users with no share right and users from other companies
403 — klip is not shared with group_id
404 — {id} or client_id not found

Permissions

klip.import

Resource URL

https://app.klipfolio.com/api/1/klips/{id}/@/import

Fields

None.

Example Request

POST https://app.klipfolio.com/api/1/klips/ec6947ab9d07fdd6b9bb41551c79fd31/@/import -d 
“{
  ‘client_id’:’0123456789abcdef0123456789abcdef’
}”

Example Response

{
   "data": {},
   "meta": {
       "status": 201,
       “location”: “/klips/01ab123012cd30123987330123da67e2”,
       "success": true
   }
}