Update Last Selected App

Returns metadata for an app, and saves an app as the last selected for a user.

Resource

1/ui-api/apps/${appId}

Available version

43.0

HTTP methods

PATCH

Example

As an example, let’s say that the user has an app with an ID of 06mRM000000AFIrYAO. To get metadata for this app, make this request:

1PATCH /services/data/v43.0/ui-api/apps/06mRM000000AFIrYAO?formFactor=Large

The PATCH request doesn’t require a request body. The request returns metadata for the app and its associated navigation items. It also updates the last selected app to be this app.

1{
2	"appId": "06mRM000000AFIrYAO",
3	"description": "Manage customer service with accounts, contacts, cases, and more",
4	"developerName": "Service",
5	"formFactors": ["Large"],
6	"headerColor": "#0070D2",
7	"iconUrl": "https://yourInstance.salesforce.com/logos/Salesforce/ServiceCloud/icon.png",
8	"isNavAutoTempTabsDisabled" : false,
9	"isNavPersonalizationDisabled" : false,
10	"label": "Service",
11	"logoUrl": "https://yourInstance.salesforce.com/logos/Salesforce/ServiceCloud/logo.png",
12	"mobileStartUrl": null,
13	"navItems": [{
14		"availableInClassic": true,
15		"availableInLightning": true,
16		"color": "EF7EAD",
17		"content": "home__desktopDefault",
18		"custom": false,
19		"developerName": "standard-home",
20		"iconUrl": "https://yourInstance.salesforce.com/img/icon/t4v35/standard/home_120.png",
21		"id": null,
22		"itemType": "Standard",
23		"label": "Home",
24		"objectApiName": "Home",
25		"pageReference": {
26			"attributes": {
27				"pageName": "home"
28			},
29			"state": {},
30			"type": "standard__namedPage"
31		},
32		"standardType": "Home"
33	}, {
34		"availableInClassic": false,
35		"availableInLightning": true,
36		"color": "489DD0",
37		"content": null,
38		"custom": false,
39		"developerName": "standard-Feed",
40		"iconUrl": "https://yourInstance.salesforce.com/img/icon/t4v35/standard/feed_120.png",
41		"id": null,
42		"itemType": "Standard",
43		"label": "Chatter",
44		"objectApiName": "Feed",
45		"pageReference": {
46			"attributes": {
47				"pageName": "chatter"
48			},
49			"state": {},
50			"type": "standard__namedPage"
51		},
52		"standardType": "Feed"
53	}],
54	"selected": true,
55	"startUrl": "https://yourInstance.salesforce.com/home/home.jsp?tsid=02uRM000000AFIr",
56	"uiType": "Classic",
57	"userNavItems": []
58}

Request parameters for PATCH

Parameter Name	Type	Description	Required or Optional	Available Version
`formFactor`	String	The form factors for which the app is supported. One of these values: `Large`—Use this value to get apps that support the desktop display size. `Medium`—Use this value to get apps that support the tablet display size. `Small`—Use this value to get apps that support the phone display size.	Required	43.0

Response body for PATCH

App

User Interface API Developer Guide

Update Last Selected App