PUT /api/apps/versions/{AppVersionID}/publicprofile

Adds or updates information about an app's public profile.

Workflow: This operation checks whether the resource is governed by a workflow, and if so whether the action is valid based on the current state of the resource. If the action is not valid, the operation will fail.

Authorization Roles/Permissions: Must be logged in. App team member, Business Admin

This topic includes the following sections:

HTTP Method

PUT

Back to top

URL

https://{hostname}/api/apps/versions/{AppVersionID}/publicprofile

Back to top

Sample Request

The example below shows an update to the app's public profile.

Request URL

https://{hostname}/api/apps/versions/90VsIX3WmpP32sqoYQk8jj4J.acmepaymentscorp/publicprofile

Sample request headers

PUT /api/apps/versions/90VsIX3WmpP32sqoYQk8jj4J.acmepaymentscorp/publicprofile HTTP/1.1
Host: {hostname}
Accept: application/json, text/javascript, */*; q=0.01
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

{
  "Title":"PaaSTime App Version 1.0",
  "SubTitle":"Games and puzzles for learning fun",
  "Description":"Learning app with games and puzzles for Android users.",
  "AppURI":"http://www.acmepaymentscorp.com/paastimev10",
  "LegalDisclaimer":"Copyright 2013 PaaSTime Ventures Inc."
}

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.
Content-Type

Any one of the following media types is valid for the request Content-Type:

application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
AppVersionID Path string Required The unique ID for a specific app version.
AppPublicProfile Body AppPublicProfile Required Contains information about an app's public profile.

Back to top

Response

If successful, this operation returns HTTP status code 200. There is no response content.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Cache-Control: no-cache
Date: Mon, 08 Jul 2013 20:32:27 GMT

Sample response body

None.

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type text/plain

Back to top

Response Body

None.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics