FAQ/API Documentation/Other API Resources

Set Custom Broadcast Message

Lockerz Admin
posted this on December 05, 2010 06:30 pm

This will let a user create a custom message when they favorite or vote on a photo.

URL

<API_Endpoint>/users/{User}/broadcastmessage/{BroadcastId}

HTTP Method

PUT

Formats

XML, JSON

Authenticated

Yes, {User} must match credentials

Input

{User} Id of user whose message is to be set.
{BroadcastId} - "ThumbsUp", "ThumbsDown", or "Favorite"

Contents

The custom message.

Output

SessionKeyOperationResponse

Parameters

N/A

Error Codes

400 BadRequest; 10026 InvalidUserId - {User} does not exist.
400 BadRequest; 10027 BadEnumValue - {BroadcastId} is not in BroadcastMessageEnum
400 BadRequest; 10028 MessageLengthExceeded - Message is greater than 90 characters long.
403 Forbidden - Credentials are incorrect or do not match {User}

Notes

N/A

Example

curl -X PUThttp://api.plixi.com/api/tpapi.svc/users/696/broadcastmessage/ThumbsUp -H "TPAPI:mlinenweber14@gmail.com,password" -H "TPSERVICE:Plixi" -d "this is a custom message"

 
Topic is closed for comments