smugmug.albums.create

Creates a new album with the specified parameters

Arguments

• SessionID - string (required).
• Title - string (required).
• CategoryID - string (required).

    essentials

• AlbumTemplateID - integer (optional).
  • default: 0
• SubCategoryID - integer (optional).
  • default: 0
• Description - string (optional).
• Keywords - string (optional).
• Geography - boolean (optional).
  • default: 1
• HighlightID - integer (optional).
• Position - integer (optional).

   look & feel

• Header - boolean (optional, power & pro only).
  • default: 0
• Clean - boolean (optional).
  • default: 0
• EXIF - boolean (optional).
  • default: 1
• Filenames - boolean (optional).
  • default: 0
• SquareThumbs - boolean (optional).
  • default: 1
• TemplateID - integer (optional).
  • 0: Viewer Choice (default)
  • 3: SmugMug
  • 4: Traditional
  • 7: All Thumbs
  • 8: Slideshow
  • 9: Journal
  • 10: SmugMug Small
  • 11: Filmstrip
• SortMethod - string (optional).
  • Position (default)
  • Caption
  • FileName
  • Date
  • DateTime
  • DateTimeOriginal
• SortDirection - boolean (optional).
  • 0: Ascending (1-99, A-Z, 1980-2004, etc)
  • 1: Descending (99-1, Z-A, 2004-1980, etc)

   security & privacy

• Password - string (optional).
• PasswordHint - string (optional).
• Public - boolean (optional).
  • default: 1
• WorldSearchable - boolean (optional).
  • default: 1
• SmugSearchable - boolean (optional).
  • default: 1
• External - boolean (optional).
  • default: 1
• Protected - boolean (optional, power & pro only).
  • default: 0
• Watermarking - boolean (optional, pro only).
  • default: 0
• WatermarkID - integer (optional, pro only).
  • 0: SmugMug Default (default)
• HideOwner - boolean (optional).
  • default: 0
• Larges - boolean (optional, pro only).
  • default: 1
• XLarges - boolean (optional, pro only).
  • default: 1
• X2Larges - boolean (optional).
  • default: 1
• X3Larges - boolean (optional).
  • default: 1
• Originals - boolean (optional).
  • default: 1

   social

• CanRank - boolean (optional).
  • default: 1
• FriendEdit - boolean (optional).
  • default: 0
• FamilyEdit - boolean (optional).
  • default: 0
• Comments - boolean (optional).
  • default: 1
• Share - boolean (optional).
  • default: 1

   printing & sales

• Printable - boolean (optional).
  • default: 1
• DefaultColor - boolean (optional, pro only).
  • 1: Auto Color
  • 0: True Color (default)
• ProofDays - integer (optional, pro only).
  • default: 0
• Backprinting - string (optional, pro only).

   photo sharpening

• UnsharpAmount - float (optional, power & pro only).
  • default: 0.200
• UnsharpRadius - float (optional, power & pro only).
  • default: 1.000
• UnsharpThreshold - float (optional, power & pro only).
  • default: 0.050
• UnsharpSigma - float (optional, power & pro only).
  • default: 1.000

   community

• CommunityID - integer (optional).
  • default: 0

Result

• struct Album
  • integer id
  • string Key

Fault Codes

• 3 - "invalid session"
• 4 - "invalid user"
• 18 - "invalid API key"

Sample Request

http://api.smugmug.com/hack/json/1.2.0/?method=smugmug.albums.create
	&SessionID=<SESSION ID>
	&Title=<ENCODED TITLE>
	&CategoryID=<CATEGORY ID>

Sample Responses

REST

<rsp stat="ok">
  <method>smugmug.albums.create</method>
  <Album id="" Key="">
</rsp>

JSON

{
  "stat":"ok",
  "method":"smugmug.albums.create",
  "Album":{"id":, "Key":""}

}

PHP

a:3:{
  s:4:"stat";s:2:"ok";
  s:6:"method";s:21:"smugmug.albums.create";
  s:5:"Album";a:1:{s:2:"id";i:;}
}

XML-RPC