Skip to main content

createAlbum

createAlbum

Request Body — REQUIRED
albumName string — REQUIRED
albumUsers object[]

This property was added in v1.104.0

role string — REQUIRED

Possible values: [editor, viewer]

userId uuid — REQUIRED
assetIds uuid[]
description string
sharedWithUserIds uuid[]

This property was deprecated in v1.104.0

Responses
201
Schema — OPTIONAL
albumName string
albumThumbnailAssetId string
albumUsers object[]
role string

Possible values: [editor, viewer]

user object
avatarColor string

Possible values: [primary, pink, red, yellow, blue, green, purple, orange, gray, amber]

createdAt date-time
deletedAt date-time
email string
id string
isAdmin boolean
memoriesEnabled boolean — OPTIONAL
name string
oauthId string
profileImagePath string
quotaSizeInBytes int64
quotaUsageInBytes int64
shouldChangePassword boolean
status string

Possible values: [active, removing, deleted]

storageLabel string
updatedAt date-time
assetCount integer
assets object[]
checksum string

base64 encoded sha1 hash

deviceAssetId string
deviceId string
duplicateId string — OPTIONAL
duration string
exifInfo object — OPTIONAL
city string — OPTIONAL
country string — OPTIONAL
dateTimeOriginal date-time — OPTIONAL
description string — OPTIONAL
exifImageHeight number — OPTIONAL
exifImageWidth number — OPTIONAL
exposureTime string — OPTIONAL
fNumber number — OPTIONAL
fileSizeInByte int64 — OPTIONAL
focalLength number — OPTIONAL
iso number — OPTIONAL
latitude number — OPTIONAL
lensModel string — OPTIONAL
longitude number — OPTIONAL
make string — OPTIONAL
model string — OPTIONAL
modifyDate date-time — OPTIONAL
orientation string — OPTIONAL
projectionType string — OPTIONAL
state string — OPTIONAL
timeZone string — OPTIONAL
fileCreatedAt date-time
fileModifiedAt date-time
hasMetadata boolean
id string
isArchived boolean
isExternal boolean — OPTIONAL

This property was deprecated in v1.104.0

isFavorite boolean
isOffline boolean
isReadOnly boolean — OPTIONAL

This property was deprecated in v1.104.0

isTrashed boolean
libraryId string
livePhotoVideoId string — OPTIONAL
localDateTime date-time
originalFileName string
originalPath string
owner object — OPTIONAL
avatarColor string

Possible values: [primary, pink, red, yellow, blue, green, purple, orange, gray, amber]

createdAt date-time
deletedAt date-time
email string
id string
isAdmin boolean
memoriesEnabled boolean — OPTIONAL
name string
oauthId string
profileImagePath string
quotaSizeInBytes int64
quotaUsageInBytes int64
shouldChangePassword boolean
status string

Possible values: [active, removing, deleted]

storageLabel string
updatedAt date-time
ownerId string
people object[] — OPTIONAL
birthDate date
faces object[]
boundingBoxX1 integer
boundingBoxX2 integer
boundingBoxY1 integer
boundingBoxY2 integer
id uuid
imageHeight integer
imageWidth integer
id string
isHidden boolean
name string
thumbnailPath string
resized boolean
smartInfo object — OPTIONAL
objects string[] — OPTIONAL
tags string[] — OPTIONAL
stack (circular)[] — OPTIONAL
stackCount integer
stackParentId string — OPTIONAL
tags object[] — OPTIONAL
id string
name string
type string

Possible values: [OBJECT, FACE, CUSTOM]

userId string
thumbhash string
type string

Possible values: [IMAGE, VIDEO, AUDIO, OTHER]

updatedAt date-time
createdAt date-time
description string
endDate date-time — OPTIONAL
hasSharedLink boolean
id string
isActivityEnabled boolean
lastModifiedAssetTimestamp date-time — OPTIONAL
order string — OPTIONAL

Possible values: [asc, desc]

owner object
avatarColor string

Possible values: [primary, pink, red, yellow, blue, green, purple, orange, gray, amber]

createdAt date-time
deletedAt date-time
email string
id string
isAdmin boolean
memoriesEnabled boolean — OPTIONAL
name string
oauthId string
profileImagePath string
quotaSizeInBytes int64
quotaUsageInBytes int64
shouldChangePassword boolean
status string

Possible values: [active, removing, deleted]

storageLabel string
updatedAt date-time
ownerId string
shared boolean
sharedUsers object[]

This property was deprecated in v1.102.0

avatarColor string

Possible values: [primary, pink, red, yellow, blue, green, purple, orange, gray, amber]

createdAt date-time
deletedAt date-time
email string
id string
isAdmin boolean
memoriesEnabled boolean — OPTIONAL
name string
oauthId string
profileImagePath string
quotaSizeInBytes int64
quotaUsageInBytes int64
shouldChangePassword boolean
status string

Possible values: [active, removing, deleted]

storageLabel string
updatedAt date-time
startDate date-time — OPTIONAL
updatedAt date-time