Skip to main content

Image_UpdateAlbumSettings​

Updates the settings of an image album.

Path Parameters
  • user string required

    The user id.

  • album string required

    The album id.

Request Body required
  • settings object required
    • name string

      The album resource name.

    • bucket string

      The bucket where to store resources.

    • systemManaged boolean

      Whether the album is system managed.

    • enableSearch boolean

      Whether images in this album show up in the search engine results.

    • enableAnnotation boolean

      Whether images in this album can be annotated.

    • enableEncryption boolean

      Whether images in this album must be client-side encrypted.

    • highVisibility boolean

      Whether the content of this album is highly visible by the public such as profile pictures and banners. Highly visible albums cannot contain sensitive or adult images.

  • updateMask field-mask

    The field mask to determine which fields are to be updated. If empty, the server will assume all fields are to be updated.

Responses

OK

Schema
  • name string

    The album resource name.

  • bucket string

    The bucket where to store resources.

  • systemManaged boolean

    Whether the album is system managed.

  • enableSearch boolean

    Whether images in this album show up in the search engine results.

  • enableAnnotation boolean

    Whether images in this album can be annotated.

  • enableEncryption boolean

    Whether images in this album must be client-side encrypted.

  • highVisibility boolean

    Whether the content of this album is highly visible by the public such as profile pictures and banners. Highly visible albums cannot contain sensitive or adult images.