You are here: Photobucket API Help > Methods > Albums > Rename Album

Rename Album

Rename the specified album.

User Login Required

Yes. See End-User Authentication for details.

HTTP Method

PUT

REST Path

/album/[identifier]

See Object Identifiers for an [identifier] explanation.

Parameters

Parameter Optional Description Variable
name N Name of result. Must be between 2 and 50 characters. Valid characters are letters, numbers, underscore ( _ ), hyphen (-), and space. String
identifier N Album identifier. String

Request Example

The request renames the album "album3" to "album2" for user "pbapi".

PUT http://api123.photobucket.com/album/pbapi%2Falbum3?format=xml&name=album2&oauth_consumer_key=00000000&oauth_nonce=7565dbed3b732c5c48a84dfb956f0bd7&oauth_signature=XBNQcReMNl%2Fkos0Xol7MxH5Qo4I%3D&oauth_signature_method=HMAC-SHA1&oauth_timestamp=1203443486&oauth_token=28.1&oauth_version=1.0

Response Example

The successful response looks similar to:

<response>

    <status>OK</status>

    <content>1</content>

    <format>xml</format>

    <method>PUT</method>

    <timestamp>1202851534</timestamp>

</response>

Error Codes

For a full list of possible errors, see Error Codes.

 

Published 25-June-10. See developer.photobucket.com for additional resources.