--- title: Update App Favorite Status description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > App Builder --- # Update App Favorite Status{% #update-app-favorite-status %} Copy pageCopied {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------------------------- | | ap1.datadoghq.com | PATCH https://api.ap1.datadoghq.com/api/v2/app-builder/apps/{app_id}/favorite | | ap2.datadoghq.com | PATCH https://api.ap2.datadoghq.com/api/v2/app-builder/apps/{app_id}/favorite | | app.datadoghq.eu | PATCH https://api.datadoghq.eu/api/v2/app-builder/apps/{app_id}/favorite | | app.ddog-gov.com | PATCH https://api.ddog-gov.com/api/v2/app-builder/apps/{app_id}/favorite | | us2.ddog-gov.com | PATCH https://api.us2.ddog-gov.com/api/v2/app-builder/apps/{app_id}/favorite | | app.datadoghq.com | PATCH https://api.datadoghq.com/api/v2/app-builder/apps/{app_id}/favorite | | us3.datadoghq.com | PATCH https://api.us3.datadoghq.com/api/v2/app-builder/apps/{app_id}/favorite | | us5.datadoghq.com | PATCH https://api.us5.datadoghq.com/api/v2/app-builder/apps/{app_id}/favorite | ### Overview Add or remove an app from the current user's favorites. Favorited apps can be filtered for using the `filter[favorite]` query parameter on the [List Apps](https://docs.datadoghq.com/api/latest/app-builder.md#list-apps) endpoint. This endpoint requires the `apps_run` permission. ### Arguments #### Path Parameters | Name | Type | Description | | ------------------------ | ------ | ------------------ | | app_id [*required*] | string | The ID of the app. | ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | -------------------------- | ------- | -------------------------------------------------------------------- | | | data | object | Data for updating an app's favorite status. | | data | attributes | object | Attributes for updating an app's favorite status. | | attributes | favorite [*required*] | boolean | Whether the app should be marked as a favorite for the current user. | | data | type | enum | The favorite resource type. Allowed enum values: `favorites` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "favorite": true }, "type": "favorites" } } ``` {% /tab %} ### Response {% tab title="204" %} No Content {% /tab %} {% tab title="400" %} Bad Request {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Forbidden {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="404" %} Not Found {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## default # \# Path parameters export app_id="65bb1f25-52e1-4510-9f8d-22d1516ed693" \# Curl command curl -X PATCH "https://api.datadoghq.com/api/v2/app-builder/apps/${app_id}/favorite" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "attributes": { "favorite": true }, "type": "favorites" } } EOF ##### ```go // Update App Favorite Status returns "No Content" response package main import ( "context" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" "github.com/google/uuid" ) func main() { body := datadogV2.UpdateAppFavoriteRequest{ Data: &datadogV2.UpdateAppFavoriteRequestData{ Attributes: &datadogV2.UpdateAppFavoriteRequestDataAttributes{ Favorite: true, }, Type: datadogV2.APPFAVORITETYPE_FAVORITES.Ptr(), }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewAppBuilderApi(apiClient) r, err := api.UpdateAppFavorite(ctx, uuid.MustParse("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"), body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AppBuilderApi.UpdateAppFavorite`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Update App Favorite Status returns "No Content" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.AppBuilderApi; import com.datadog.api.client.v2.model.AppFavoriteType; import com.datadog.api.client.v2.model.UpdateAppFavoriteRequest; import com.datadog.api.client.v2.model.UpdateAppFavoriteRequestData; import com.datadog.api.client.v2.model.UpdateAppFavoriteRequestDataAttributes; import java.util.UUID; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); AppBuilderApi apiInstance = new AppBuilderApi(defaultClient); UpdateAppFavoriteRequest body = new UpdateAppFavoriteRequest() .data( new UpdateAppFavoriteRequestData() .attributes(new UpdateAppFavoriteRequestDataAttributes().favorite(true)) .type(AppFavoriteType.FAVORITES)); try { apiInstance.updateAppFavorite(UUID.fromString("65bb1f25-52e1-4510-9f8d-22d1516ed693"), body); } catch (ApiException e) { System.err.println("Exception when calling AppBuilderApi#updateAppFavorite"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```python """ Update App Favorite Status returns "No Content" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.app_builder_api import AppBuilderApi from datadog_api_client.v2.model.app_favorite_type import AppFavoriteType from datadog_api_client.v2.model.update_app_favorite_request import UpdateAppFavoriteRequest from datadog_api_client.v2.model.update_app_favorite_request_data import UpdateAppFavoriteRequestData from datadog_api_client.v2.model.update_app_favorite_request_data_attributes import ( UpdateAppFavoriteRequestDataAttributes, ) from uuid import UUID body = UpdateAppFavoriteRequest( data=UpdateAppFavoriteRequestData( attributes=UpdateAppFavoriteRequestDataAttributes( favorite=True, ), type=AppFavoriteType.FAVORITES, ), ) configuration = Configuration() with ApiClient(configuration) as api_client: api_instance = AppBuilderApi(api_client) api_instance.update_app_favorite(app_id=UUID("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d"), body=body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Update App Favorite Status returns "No Content" response require "datadog_api_client" api_instance = DatadogAPIClient::V2::AppBuilderAPI.new body = DatadogAPIClient::V2::UpdateAppFavoriteRequest.new({ data: DatadogAPIClient::V2::UpdateAppFavoriteRequestData.new({ attributes: DatadogAPIClient::V2::UpdateAppFavoriteRequestDataAttributes.new({ favorite: true, }), type: DatadogAPIClient::V2::AppFavoriteType::FAVORITES, }), }) api_instance.update_app_favorite("9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d", body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```rust // Update App Favorite Status returns "No Content" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_app_builder::AppBuilderAPI; use datadog_api_client::datadogV2::model::AppFavoriteType; use datadog_api_client::datadogV2::model::UpdateAppFavoriteRequest; use datadog_api_client::datadogV2::model::UpdateAppFavoriteRequestData; use datadog_api_client::datadogV2::model::UpdateAppFavoriteRequestDataAttributes; use uuid::Uuid; #[tokio::main] async fn main() { let body = UpdateAppFavoriteRequest::new().data( UpdateAppFavoriteRequestData::new() .attributes(UpdateAppFavoriteRequestDataAttributes::new(true)) .type_(AppFavoriteType::FAVORITES), ); let configuration = datadog::Configuration::new(); let api = AppBuilderAPI::with_config(configuration); let resp = api .update_app_favorite( Uuid::parse_str("00000000-0000-0000-0000-000000000000").expect("invalid UUID"), body, ) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Update App Favorite Status returns "No Content" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); const apiInstance = new v2.AppBuilderApi(configuration); const params: v2.AppBuilderApiUpdateAppFavoriteRequest = { body: { data: { attributes: { favorite: true, }, type: "favorites", }, }, appId: "9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d", }; apiInstance .updateAppFavorite(params) .then((data: any) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}