Welcome, guest Sign In

Status

Description

The Status API allows for users to set and share their status on Yahoo! and on applications. The user's status is a string with a maximum length of 140 characters; anything longer will be silently truncated. The Status API filters unsafe user input to avoid security issues such as invalid characters in a URL, SQL injections, or cross-site scripting.

Yahoo! Profile users can enter text that indicates their status. The text is free form allowing users to enter any information including URLs. However, the convention is to indicate the user's current activity, mood, or location. Examples of text for the status are:

  • "watching a movie"
  • "I'm on a business trip in Japan until July 28."
  • "went out for a run, will be back home by 3"
  • "Check out my new blog: http://mysite.com/blog"

URI

GET returns the current status of a profile owner specified by the {guid}. PUT updates the status of a profile owner specified by the {guid}.

POST replaces the status with its corresponding permission of a profile owner specified by the {guid}.

http://social.yahooapis.com/v1/user/{guid}/profile/status

HTTP Operations Supported

  • GET
  • PUT

Query Parameters Supported

  • callback
  • format

Matrix Parameters Supported

Not available.

Scopes Required

  • GET: Read Yahoo! Status
  • PUT: Read/Write Yahoo! Status

Elements of the Status Object

Element JSON Data Type XML Schema Data Type Required for Write Read Only? Description
status Status object Status object Yes No Object containing the profile owner's status.
message string string Yes No Status text of the profile owner.
lastStatusModified string dateTime No Yes Time of the last status update.
uri string anyURI No Yes Reference to the actual resource.

JSON Syntax for Status Object

XMLSyntax for Status Object

Example JSON Response Body for GET Status

Example XML Response Body for GET Status

Example JSON Request Body for PUT Status

Example XML Request Body for PUT Status

Table of Contents

Copyright © 2009 Yahoo! Inc. All rights reserved. Copyright | Privacy Policy

Help us continue to improve the Yahoo! Developer Network: Send Your Suggestions