PUT /api/apps/{AppID}

Changes one or more values for an app (Name and/or Description).

For a training exercise that uses this operation, including video, see Example: Adding an App Avatar.

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

Authorization token renewal: This operation changes information that is reflected in the authorization token; therefore, when invoking this operation, you must also renew the token.

This topic includes the following sections:

HTTP Method

PUT

URL

https://{hostname}/api/apps/{AppID}

Sample Request

Sample request URL

https://{hostname}/api/apps/4EJDs5fHlFN4elPSRo0qp66A.acmepaymentscorp

Sample request headers

Host:{hostname}
Accept: */*
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body #1

The example below modifies the app name and description.

{
  "Name":"MyAppNewName",
  "Description":"Revised description of my app."
}

Sample request body #2

The example below assigns an avatar to the app by providing the DropboxID of an image previously uploaded to the Dropbox (see POST /api/dropbox/pictures).

{
  "Name": "TravelApp",
  "PictureID":"1234"
}

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
Cookie	AtmoAuthToken_{fedmemberid}={cookie value, which usually starts with TokenID}—The platform cookie. This is the Akana API Platform authorization token, and must be sent with every API request that requires login. For more information and an example, see Session cookies.
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.

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
AppID	Path	string	Required	The unique ID for a specific app.
Application	Body	Application	Required	Modified information about the app. Required properties: Name.

Response

If successful, this operation returns HTTP status code 200, with the AppID of the modified app in plain text.

Sample Response

The sample response below shows the AppID returned in plain text.

Sample response headers

HTTP/1.1 200 OK
Date: Fri, 25 Sep 2015 09:54:32 GMT
Content-Type: text/plain
Atmo-Renew-Token: renew

Sample response body

4EJDs5fHlFN4elPSRo0qp66A.acmepaymentscorp

Response Headers

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

Header	Description
Content-Type	text/plain
Atmo-Renew-Token	renew

Response Body

Name	Type	Description
AppID	string	The unique ID for a specific app.

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.

Related Topics