Yoto Developers
Search K

Appearance

upload a family image​

POST
/media/family/images

Upload an image for a family for use across various features in Yoto. Currently this is only in use when uploading a group image in the app card library, but could be used by other features in future.

  • The image must be sent as a binary format

  • The image can be no bigger than 8mb in size. Anything larger will return a 400 Bad Request.

  • There are no restrictions for the resolution or aspect ratio of the image

  • Only the following types of images are supported: JPEG, GIF, PNG

  • A family can upload no more than 500 images. Once this limit is reached a 400 Bad Request is returned for subsequent upload attempts.

If uploaded successfully a 200 OK is returned with a body showing:

  • The Id of the image (the SHA256 checksum for the file)

  • A URL to the 'get a family image' endpoint for the image. Note width and height params will need to be appended to retrieve an image with your required dimensions.

If the same image is uploaded more than once, it will be matched via the SHA256 checksum to avoid duplicates.

Authorizations​

bearerAuth
TypeHTTP (bearer)

Request Body​

text/plain
JSON
"'something'"

Responses​

200 OK
application/json
JSON
{
"imageId": "1afea16db1aeb62f8ba84cdb191eee7c1dd734d23098b4756717c3e2bded8c6a",
"url": "https://api.yotoplay.com/media/family/images/1afea16db1aeb62f8ba84cdb191eee7c1dd734d23098b4756717c3e2bded8c6a"
}

Playground​

Authorization
Body

Samples​