Sets the UPML for a user's profile, including the content for both the profile box and the profile actions. See the UPML documentation for a description of the markup and its role in various contexts.
The UPML is cached on Universal Platform's server for that particular user and that particular application. To change it, up.profile.setUPML must be called through a canvas page.
| Type | Name | Required | Description |
|---|---|---|---|
string
| api_key | ✔ | The application key associated with the calling application. |
string
| community | ✔ | Community system name. Use up.community.getList method to retrieve available communities. |
string
| session_key | ✔ | The session key of the logged in user. |
string
| sig | ✔ | An MD5 hash of the current request and your secret key, as described in the authentication guide. |
string
| format | Desired response format. Either XML (default) or JSON.
| |
string
| markup | ✔ | The UPML intended for the user's profile |
int
| uid | The user whose profile is to be updated. If not specified, defaults to the logged-in user. Not allowed for desktop applications (since the application secret is essentially public). |
<?xml version="1.0" encoding="UTF-8"?> <profile_setUPML_response> 1 </profile_setUPML_response>
| Code | Description |
|---|---|
| 1 | An unknown error occurred. Please resubmit the request. |
| 2 | The service is not available at this time. |
| 3 | Unknown Method. The method must be one of those exposed by the API documentation. |
| 4 | The application has reached the maximum number of requests allowed. More requests are allowed once the time window has completed. |
| 5 | The request came from a remote address not allowed by this application. |
| 100 | One of the parameters specified was missing or invalid. |
| 101 | The api key submitted is not associated with any known application. |
| 102 | The session key was improperly submitted or has reached its timeout. Direct the user to log in again to obtain another key. |
| 104 | Incorrect signature. |
| 240 | The uid cannot be specified from a desktop application. |
| 330 | The markup was invalid |