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

Responses

200

200 OK application/json

Schema

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

JSON

{
  "cards": [
    {
      "availability": "premium",
      "cardId": "5IiME",
      "content": {
        "activity": "yoto_Player",
        "chapters": [
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#f9yadvT_NnXvq6di120C7gOVFv9puAIAEvopzTAJUoc"
            },
            "key": "01",
            "overlayLabel": "1",
            "overlayLabelOverride": "1",
            "title": "Flight of the Bumblebee",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#f9yadvT_NnXvq6di120C7gOVFv9puAIAEvopzTAJUoc"
                },
                "format": "aac",
                "key": "01",
                "title": "Flight of the Bumblebee",
                "trackUrl": "yoto:#NudzVLThRTvNB1gFpIehxnw1Y2h-1X1qYH2hOaEC8Sk",
                "type": "audio"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#i7gtJOewdaEQipPSaEzNuMLge_YZRdkKBgsDUbBdURg"
            },
            "key": "02",
            "overlayLabel": "2",
            "overlayLabelOverride": "2",
            "title": "Allegro",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#i7gtJOewdaEQipPSaEzNuMLge_YZRdkKBgsDUbBdURg"
                },
                "format": "aac",
                "key": "02",
                "title": "Allegro",
                "trackUrl": "yoto:#J2FuNSy8uY08QB49lVW--RftZhXnBdtrpi0Td2zCWiU",
                "type": "audio"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#ifiMh5pERuDpVufVWkM_EXBxVYHthkZ-vhaqD3fbMy4"
            },
            "key": "03",
            "overlayLabel": "3",
            "overlayLabelOverride": "3",
            "title": "March No. 1",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#ifiMh5pERuDpVufVWkM_EXBxVYHthkZ-vhaqD3fbMy4"
                },
                "format": "aac",
                "key": "03",
                "title": "March No. 1",
                "trackUrl": "yoto:#HmL1tk1E-CiEaciE6G5MsdTCTr_6I2fHq8Hbjq5nxlE",
                "type": "audio"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#ZUM27Zq3bSfQG6-wrwx3P8ABUZQWoY3k0RE6ddRSS2s"
            },
            "key": "04",
            "overlayLabel": "4",
            "overlayLabelOverride": "4",
            "title": "The Cat",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#ZUM27Zq3bSfQG6-wrwx3P8ABUZQWoY3k0RE6ddRSS2s"
                },
                "format": "aac",
                "key": "04",
                "title": "The Cat",
                "trackUrl": "yoto:#G8waAF6OxDdmPer26Yg8dxAfm57YumK0ZyDz_PIQYws",
                "type": "audio"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#rrqSbpjB5kLGNntHPYNAy6RzZ24stYpu7IDELRJoxVA"
            },
            "key": "05",
            "overlayLabel": "5",
            "overlayLabelOverride": "5",
            "title": "Allegretto",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#rrqSbpjB5kLGNntHPYNAy6RzZ24stYpu7IDELRJoxVA"
                },
                "format": "aac",
                "key": "05",
                "title": "Allegretto",
                "trackUrl": "yoto:#OIAeWyL0MS8bMzezjeJ3TSGYgl8mhgj_0-DsETOWNyM",
                "type": "audio"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#Va2VPegpqeEGNdsSKZE5SOjCMYtJY1_UyyulfQWzwWM"
            },
            "key": "06",
            "overlayLabel": "6",
            "overlayLabelOverride": "6",
            "title": "Andante",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#Va2VPegpqeEGNdsSKZE5SOjCMYtJY1_UyyulfQWzwWM"
                },
                "format": "aac",
                "key": "06",
                "title": "Andante",
                "trackUrl": "yoto:#YyDxs-VMc4L2mXYyp55gVvNDGkKO6dhugHJChTk5TgY",
                "type": "audio"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#ZQrnsDY36P6p9Ub0qWQ-VWFZVss--5-xPwW4kBDyZss"
            },
            "key": "07",
            "overlayLabel": "7",
            "overlayLabelOverride": "7",
            "title": "Swan's Dance",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#ZQrnsDY36P6p9Ub0qWQ-VWFZVss--5-xPwW4kBDyZss"
                },
                "format": "aac",
                "key": "07",
                "title": "Swan's Dance",
                "trackUrl": "yoto:#MsijRooPatfnO95qsCI-aCC867ZjW4992CX-2EjPToY",
                "type": "audio"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#8qjf4P08uiiekEyfhklpbF6_mrL8uRznRazM8c6l8h8"
            },
            "key": "08",
            "overlayLabel": "8",
            "overlayLabelOverride": "8",
            "title": "Aquarium",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#8qjf4P08uiiekEyfhklpbF6_mrL8uRznRazM8c6l8h8"
                },
                "format": "aac",
                "key": "08",
                "title": "Aquarium",
                "trackUrl": "yoto:#wa3SjkqvYylH8UKEO9SqTq4T5vnVmtB5nhpE2gCnR_4",
                "type": "audio"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#u41KmrvVLRR0dwQDGHdCYXPxZqlxroaRP1ZGcnxr4ks"
            },
            "key": "09",
            "overlayLabel": "9",
            "overlayLabelOverride": "9",
            "title": "Lullaby in G Major",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#u41KmrvVLRR0dwQDGHdCYXPxZqlxroaRP1ZGcnxr4ks"
                },
                "format": "aac",
                "key": "09",
                "title": "Lullaby in G Major",
                "trackUrl": "yoto:#kZSauvI8gU5mVXCf8qijLWDPaOrXFL-aQ0YNgopETUg",
                "type": "audio"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#EbXWxxCyyHyCs9jOqad0g4R-xxlkWwi3E_KAWryPQAA"
            },
            "key": "10",
            "overlayLabel": "10",
            "overlayLabelOverride": "10",
            "title": "The Prince Seeks The Princess",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#EbXWxxCyyHyCs9jOqad0g4R-xxlkWwi3E_KAWryPQAA"
                },
                "format": "aac",
                "key": "10",
                "title": "The Prince Seeks The Princess",
                "trackUrl": "yoto:#7Hp1IWo54tOu617ztOKGKB-g4ZAToesc-8Br7QW4XpA",
                "type": "audio"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#rrqSbpjB5kLGNntHPYNAy6RzZ24stYpu7IDELRJoxVA"
            },
            "key": "11",
            "overlayLabel": "11",
            "overlayLabelOverride": "11",
            "title": "Clair de lune",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#rrqSbpjB5kLGNntHPYNAy6RzZ24stYpu7IDELRJoxVA"
                },
                "format": "aac",
                "key": "11",
                "title": "Clair de lune",
                "trackUrl": "yoto:#bcPCgC7vYf0hOFHa_XGkW1v6MVpGdeWGFVmBwuMCvW8",
                "type": "audio"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#LQc7rz0J4iBHRq9wPxE7WoUejCsATiMW0CRyw8pS3bw"
            },
            "key": "12",
            "overlayLabel": "12",
            "overlayLabelOverride": "12",
            "title": "Adagio Sostenuto",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#LQc7rz0J4iBHRq9wPxE7WoUejCsATiMW0CRyw8pS3bw"
                },
                "format": "aac",
                "key": "12",
                "title": "Adagio Sostenuto",
                "trackUrl": "yoto:#hLIkVp44QnSRHft6lrJaZehGY8KUTAvrg2g4ceDvqC4",
                "type": "audio"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#k2bEBdumRdqhU0HaxGVnRlkT8ZPHi79N13wnxMSe8Bo"
            },
            "key": "13",
            "overlayLabel": "13",
            "overlayLabelOverride": "13",
            "title": "The Story of Babar",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#k2bEBdumRdqhU0HaxGVnRlkT8ZPHi79N13wnxMSe8Bo"
                },
                "format": "aac",
                "key": "13",
                "title": "The Story of Babar",
                "trackUrl": "yoto:#y-4NAQJuK2Bq3XJ44cl_1f0jNumyV0S3Lak7F8DbfBg",
                "type": "audio"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#wSU7XODZdwFU4aPIie0oj5hx3D9A_MMqZVT2fY6e_AI"
            },
            "key": "14",
            "overlayLabel": "14",
            "overlayLabelOverride": "14",
            "title": "March",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#wSU7XODZdwFU4aPIie0oj5hx3D9A_MMqZVT2fY6e_AI"
                },
                "format": "aac",
                "key": "14",
                "title": "March",
                "trackUrl": "yoto:#zx2XZyOOMwwuss92bzQ5f4WG9UfxRZC_Du6r1C1Up9E",
                "type": "audio"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#YKFyOWGl7W1yX2wRXRXRLYHn8KHfQ66_3e0YcNebHIc"
            },
            "key": "15",
            "overlayLabel": "15",
            "overlayLabelOverride": "15",
            "title": "Cinderella's Waltz",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#YKFyOWGl7W1yX2wRXRXRLYHn8KHfQ66_3e0YcNebHIc"
                },
                "format": "aac",
                "key": "15",
                "title": "Cinderella's Waltz",
                "trackUrl": "yoto:#pDTkQ79SPtTnY0P7l29nTG2rKKrZZiAgEelr20xIves",
                "type": "audio"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#yT9KYolfx4X4YRETZgGNHSzE2mANsXEG_AyAlf5yZgQ"
            },
            "key": "16",
            "overlayLabel": "16",
            "overlayLabelOverride": "16",
            "title": "Harry's Wondrous World",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#yT9KYolfx4X4YRETZgGNHSzE2mANsXEG_AyAlf5yZgQ"
                },
                "format": "aac",
                "key": "16",
                "title": "Harry's Wondrous World",
                "trackUrl": "yoto:#PyZiLz_D2t-GazGgaCMoediLS8qcbMujPbUHRE-z9U8",
                "type": "audio"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#_B8eFuBVO19aRhyDePUMQJch91jfWdLmfkjqaMW4Lfg"
            },
            "key": "17",
            "overlayLabel": "17",
            "overlayLabelOverride": "17",
            "title": "Grand old Duke of York",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#_B8eFuBVO19aRhyDePUMQJch91jfWdLmfkjqaMW4Lfg"
                },
                "format": "aac",
                "key": "17",
                "title": "Grand old Duke of York",
                "trackUrl": "yoto:#uz6CGzzljEGLQcz0hFdG-dlaDhuq3IXvgVxKP2VY8Bg",
                "type": "audio"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#3eSBaxBr8Hahw_8dHyfAmubFRkvSXLdHYBUiKYUcoig"
            },
            "key": "18",
            "overlayLabel": "18",
            "overlayLabelOverride": "18",
            "title": "The Awakening",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#3eSBaxBr8Hahw_8dHyfAmubFRkvSXLdHYBUiKYUcoig"
                },
                "format": "aac",
                "key": "18",
                "title": "The Awakening",
                "trackUrl": "yoto:#naqn6eDZIJCoj9ZyMjTVopWgQBg_OF8qBQpjMeNpuk0",
                "type": "audio"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#EcxVCbU4Y1ibLUqVLjwKy85ZFEsp9DCFNcq_fyb2HqE"
            },
            "key": "19",
            "overlayLabel": "19",
            "overlayLabelOverride": "19",
            "title": "Ride of the Valkyries",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#EcxVCbU4Y1ibLUqVLjwKy85ZFEsp9DCFNcq_fyb2HqE"
                },
                "format": "aac",
                "key": "19",
                "title": "Ride of the Valkyries",
                "trackUrl": "yoto:#b0iBH-6r2nWl6QJrEShfhT-6bYat77jO_BXeymh1vK0",
                "type": "audio"
              }
            ]
          },
          {
            "ambient": null,
            "defaultTrackAmbient": null,
            "defaultTrackDisplay": null,
            "display": {
              "icon16x16": "yoto:#vA-snF9i1e--37c73iFpVbv_ff08SQELRdhgPOgqUQk"
            },
            "key": "20",
            "overlayLabel": "20",
            "overlayLabelOverride": "20",
            "title": "Waltz of the Flowers",
            "tracks": [
              {
                "ambient": null,
                "display": {
                  "icon16x16": "yoto:#vA-snF9i1e--37c73iFpVbv_ff08SQELRdhgPOgqUQk"
                },
                "format": "aac",
                "key": "20",
                "title": "Waltz of the Flowers",
                "trackUrl": "yoto:#frVuJbVg1YhcSdvAxL9aeh6FERBIBbKMJE1wyoS9snQ",
                "type": "audio"
              }
            ]
          }
        ],
        "config": {
          "disableAutoOverlayLabels": false
        },
        "editSettings": {
          "autoOverlayLabels": "disabled",
          "editKeys": false
        },
        "version": "1"
      },
      "createdAt": "2020-04-08T10:10:14.913Z",
      "metadata": {
        "author": "Naxos",
        "category": "music",
        "cover": {},
        "description": null,
        "order": "500"
      },
      "slug": "naxos-adventures-in-music",
      "title": "Adventures in Music",
      "updatedAt": "2020-04-08T10:10:27.491Z",
      "userId": "yoto"
    }
  ],
  "createdAt": "2024-06-06T13:10:08.688Z",
  "familyId": "65b120377258d846de4595d8",
  "id": "GQxXQ3ZkaitgRVJ6dFW8m",
  "imageId": "fp-cards",
  "imageUrl": "https://cdn.yoto.io/library/groups/fp-cards.png",
  "items": [
    {
      "addedAt": "2024-06-06T13:10:14.100Z",
      "contentId": "5IiME"
    }
  ],
  "lastModifiedAt": "2024-06-06T13:10:14.087Z",
  "name": "No Longer My Favourites"
}

Body application/json

imageId string

Example fp-cards

items array

Example [{"contentId":"5IiME"}]

name string

Example No Longer My Favourites

Path Parameters

groupId string Required

PUT

/card/family/library/groups/{groupId}

Server URL: https://api.yotoplay.com

Authorization (bearerAuth)

Token

Request Body

Try it out

cURL

curl "https://api.yotoplay.com/card/family/library/groups/{groupId}"
--header "Authorization: Bearer [YOUR_TOKEN]"

JavaScript

const options = {
  method: 'PUT',
  headers: {
    'Authorization': 'Bearer [YOUR_TOKEN]'
  }
};

fetch('https://api.yotoplay.com/card/family/library/groups/{groupId}', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.yotoplay.com/card/family/library/groups/{groupId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer [YOUR_TOKEN]"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://api.yotoplay.com/card/family/library/groups/{groupId}"

headers = {
    "Authorization": "Bearer [YOUR_TOKEN]"
}

response = requests.request("PUT", url, headers=headers)

print(response.text)