Yoto Developers
Update A Group

Update A Group

Update a group for a family.

  • The contextual family is the authorised user's family

  • Groups can only be updated if a family owns them

    • If it does not exist a 404 is returned

    • If it exists but is owned by another family, a 404 is returned

  • All of the critiera for creating a group applies

Required Scope

family:library:manage

Responses

200 OKapplication/json
cardsarray
[items]object
availabilitystring
cardIdstring
contentobject
activitystring
chaptersarray
[items]object
ambient
defaultTrackAmbient
defaultTrackDisplay
displayobject
icon16x16string
keystring
overlayLabelstring
overlayLabelOverridestring
titlestring
tracksarray
[items]object
ambient
displayobject
icon16x16string
formatstring
keystring
titlestring
trackUrlstring
typestring
configobject
disableAutoOverlayLabelsboolean
editSettingsobject
autoOverlayLabelsstring
editKeysboolean
versionstring
createdAtstring
metadataobject
authorstring
categorystring
coverobject
description
orderstring
slugstring
titlestring
updatedAtstring
userIdstring
createdAtstring
familyIdstring
idstring
imageIdstring
imageUrlstring
itemsarray
[items]object
addedAtstring
contentIdstring
lastModifiedAtstring
namestring

Body application/json

imageIdstring
Examplefp-cards
itemsarray
Example[{"contentId":"5IiME"}]
namestring
ExampleNo Longer My Favourites

Path Parameters

groupIdstringRequired
PUT
/card/family/library/groups/{groupId}
Server URL: https://api.yotoplay.com
Request Body
curl "https://api.yotoplay.com/card/family/library/groups/{groupId}"