You are here: Photobucket API Help > Methods > Group Albums > Update Group Album Privacy Settings

Update Group Album Privacy Settings

Change a group album's privacy setting, including password.

User Login Required

Yes. See End-User Authentication for details.

HTTP Method

PUT or POST

REST Path

/group/[identifier]/privacy

See Object Identifiers for an [identifier] explanation.

Parameters

Parameter Optional Description Variable
privacy N Whether the album is public or private. String
identifier N Album identifier. String
password N Password for a private album, if privacy=private. Passwords must be at least six characters long. They can only contain the characters a-z, A-Z, 0-9, hyphen ( - ), and underscore ( _ ). Passwords cannot contain spaces or start with a zero. The guest password must also be different than the owner's Photobucket password. String

Request Example

The request changes the "FOYJ8ZK56" group album privacy setting from private to public.

PUT http://api123.photobucket.com/group/FOYJ8ZK56/privacy?format=xml&oauth_consumer_key=00000000&oauth_nonce=6182ebf9ae9facf5491329a1d403852d&oauth_signature=vI85ZulTP0KftsmYjgHSSFwqD%2BQ%3D&oauth_signature_method=HMAC-SHA1&oauth_timestamp=1214504385&oauth_token=28.10_1214504385&oauth_version=1.0&privacy=public 

Response Example

The successful response includes the <content> tag which verifies the change.

<response>

    <status>OK</status>

    <content>public</content>

    <format>xml</format>

    <method>PUT</method>

    <timestamp>1214504386</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.