--- title: Patch subject type description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Experiments --- > For the complete documentation index, see [llms.txt](https://docs.datadoghq.com/llms.txt). {% callout %} # Important note for users on the following Datadog sites: app.ddog-gov.com, us2.ddog-gov.com {% alert level="danger" %} This product is not supported for your selected [Datadog site](https://docs.datadoghq.com/getting_started/site.md). ({% placeholder "user-datadog-site-name" /%}). {% /alert %} {% /callout %} # Patch subject type{% #patch-subject-type %} {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | -------------------------------------------------------------------------------------- | | ap1.datadoghq.com | PATCH https://api.ap1.datadoghq.com/api/v2/experiments/subject-types/{subject_type_id} | | ap2.datadoghq.com | PATCH https://api.ap2.datadoghq.com/api/v2/experiments/subject-types/{subject_type_id} | | app.datadoghq.eu | PATCH https://api.datadoghq.eu/api/v2/experiments/subject-types/{subject_type_id} | | app.ddog-gov.com | PATCH https://api.ddog-gov.com/api/v2/experiments/subject-types/{subject_type_id} | | us2.ddog-gov.com | PATCH https://api.us2.ddog-gov.com/api/v2/experiments/subject-types/{subject_type_id} | | uk1.datadoghq.com | PATCH https://api.uk1.datadoghq.com/api/v2/experiments/subject-types/{subject_type_id} | | app.datadoghq.com | PATCH https://api.datadoghq.com/api/v2/experiments/subject-types/{subject_type_id} | | us3.datadoghq.com | PATCH https://api.us3.datadoghq.com/api/v2/experiments/subject-types/{subject_type_id} | | us5.datadoghq.com | PATCH https://api.us5.datadoghq.com/api/v2/experiments/subject-types/{subject_type_id} | ### Overview Update mutable fields on a subject type. Only the fields present in the body are changed. Any subject type can be updated, including the organization's default one, but the is_default flag itself is read-only here: which subject type is the default cannot be changed through this endpoint. This endpoint requires the `product_analytics_settings_write` permission. OAuth apps require the `product_analytics_settings_write` authorization [scope](https://docs.datadoghq.com/api/latest/scopes.md#experiments) to access this endpoint. ### Arguments #### Path Parameters | Name | Type | Description | | --------------------------------- | ------ | ----------------------------- | | subject_type_id [*required*] | string | The UUID of the subject type. | ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ---------------------------- | -------- | ------------------------------------------------------------------- | | | data [*required*] | object | JSON:API resource containing the subject type identity and fields. | | data | attributes [*required*] | object | Fields supplied to update the subject type. | | attributes | migration_metadata | | Metadata retained for resources imported from another system. | | attributes | name | string | Display name of the subject type. | | attributes | product_analytics_attribute | string | Product Analytics attribute used to identify subjects of this type. | | attributes | warehouse_column_names | [string] | Warehouse columns that identify subjects of this type. | | data | id | string | ID of the subject type. | | data | type [*required*] | enum | Subject types resource type. Allowed enum values: `subject-types` | {% /tab %} {% tab title="Example" %} ```json { "data": { "type": "subject-types", "attributes": { "name": "ex-14bb9543f523edde updated" } } } ``` {% /tab %} ### Response {% tab title="200" %} OK {% tab title="Model" %} Response containing the subject type. | Parent field | Field | Type | Description | | ------------ | --------------------------- | --------- | ------------------------------------------------------------------- | | | data [*required*] | object | JSON:API resource containing the subject type identity and fields. | | data | attributes | object | Details of the subject type. | | attributes | created_at | date-time | Time when this resource was created. | | attributes | experiment_count | int64 | Number of experiments that reference this resource. | | attributes | exposure_source_count | int64 | Number of exposure sources that reference this subject type. | | attributes | is_default | boolean | Whether this is the organization's default subject type. | | attributes | metric_sql_model_count | int64 | Number of metric SQL models that reference this subject type. | | attributes | migration_metadata | | Metadata retained for resources imported from another system. | | attributes | name | string | Display name of the subject type. | | attributes | product_analytics_attribute | string | Product Analytics attribute used to identify subjects of this type. | | attributes | protocol_count | int64 | Number of protocols that reference this subject type. | | attributes | updated_at | date-time | Time when this resource was last updated. | | attributes | warehouse_column_names | [string] | Warehouse columns that identify subjects of this type. | | data | id [*required*] | uuid | ID of the subject type. | | data | type [*required*] | enum | Subject types resource type. Allowed enum values: `subject-types` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "created_at": "2024-01-01T12:00:00Z", "is_default": true, "name": "User", "product_analytics_attribute": "@usr.id", "updated_at": "2024-01-01T12:00:00Z", "warehouse_column_names": [ "user_id", "customer_id" ] }, "id": "550e8400-e29b-41d4-a716-446655440010", "type": "subject-types" } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Malformed subject type ID, malformed body, or no updatable field supplied. {% 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="401" %} Missing or invalid authentication. {% 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" %} Authenticated caller lacks the product_analytics_settings_write permission. {% 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" %} No subject type with this ID exists for the organization. {% 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 subject_type_id="550e8400-e29b-41d4-a716-446655440000" \# Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" \# Curl command curl -X PATCH "https://api.datadoghq.com/api/v2/experiments/subject-types/${subject_type_id}" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" \ -d @- << EOF { "data": { "attributes": { "name": "Updated User", "product_analytics_attribute": "@usr.id", "warehouse_column_names": [ "user_id" ] }, "type": "subject-types" } } EOF ##### ```go // Patch subject type returns "OK" response package main import ( "context" "encoding/json" "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() { // there is a valid "experiment_subject_type" in the system ExperimentSubjectTypeDataID := uuid.MustParse(os.Getenv("EXPERIMENT_SUBJECT_TYPE_DATA_ID")) body := datadogV2.ExperimentsPatchSubjectTypeV2Request{ Data: datadogV2.ExperimentsPatchSubjectTypeV2RequestData{ Type: datadogV2.EXPERIMENTSSUBJECTTYPEV2DTODATATYPE_SUBJECT_TYPES, Attributes: datadogV2.ExperimentsPatchSubjectTypeV2RequestDataAttributes{ Name: datadog.PtrString("ex-14bb9543f523edde updated"), }, }, } ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewExperimentsApi(apiClient) resp, r, err := api.PatchSubjectType(ctx, ExperimentSubjectTypeDataID, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ExperimentsApi.PatchSubjectType`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `ExperimentsApi.PatchSubjectType`:\n%s\n", responseContent) } ``` #### 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_BEARER_TOKEN="" go run "main.go" ##### ```java // Patch subject type returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.ExperimentsApi; import com.datadog.api.client.v2.model.ExperimentsPatchSubjectTypeV2Request; import com.datadog.api.client.v2.model.ExperimentsPatchSubjectTypeV2RequestData; import com.datadog.api.client.v2.model.ExperimentsPatchSubjectTypeV2RequestDataAttributes; import com.datadog.api.client.v2.model.ExperimentsSubjectTypeV2DTO; import com.datadog.api.client.v2.model.ExperimentsSubjectTypeV2DTODataType; import java.util.UUID; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); ExperimentsApi apiInstance = new ExperimentsApi(defaultClient); // there is a valid "experiment_subject_type" in the system UUID EXPERIMENT_SUBJECT_TYPE_DATA_ID = null; try { EXPERIMENT_SUBJECT_TYPE_DATA_ID = UUID.fromString(System.getenv("EXPERIMENT_SUBJECT_TYPE_DATA_ID")); } catch (IllegalArgumentException e) { System.err.println("Error parsing UUID: " + e.getMessage()); } ExperimentsPatchSubjectTypeV2Request body = new ExperimentsPatchSubjectTypeV2Request() .data( new ExperimentsPatchSubjectTypeV2RequestData() .type(ExperimentsSubjectTypeV2DTODataType.SUBJECT_TYPES) .attributes( new ExperimentsPatchSubjectTypeV2RequestDataAttributes() .name("ex-14bb9543f523edde updated"))); try { ExperimentsSubjectTypeV2DTO result = apiInstance.patchSubjectType(EXPERIMENT_SUBJECT_TYPE_DATA_ID, body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ExperimentsApi#patchSubjectType"); 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_BEARER_TOKEN="" java "Example.java" ##### ```python """ Patch subject type returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.experiments_api import ExperimentsApi from datadog_api_client.v2.model.experiments_patch_subject_type_v2_request import ExperimentsPatchSubjectTypeV2Request from datadog_api_client.v2.model.experiments_patch_subject_type_v2_request_data import ( ExperimentsPatchSubjectTypeV2RequestData, ) from datadog_api_client.v2.model.experiments_patch_subject_type_v2_request_data_attributes import ( ExperimentsPatchSubjectTypeV2RequestDataAttributes, ) from datadog_api_client.v2.model.experiments_subject_type_v2_dto_data_type import ExperimentsSubjectTypeV2DTODataType # there is a valid "experiment_subject_type" in the system EXPERIMENT_SUBJECT_TYPE_DATA_ID = environ["EXPERIMENT_SUBJECT_TYPE_DATA_ID"] body = ExperimentsPatchSubjectTypeV2Request( data=ExperimentsPatchSubjectTypeV2RequestData( type=ExperimentsSubjectTypeV2DTODataType.SUBJECT_TYPES, attributes=ExperimentsPatchSubjectTypeV2RequestDataAttributes( name="ex-14bb9543f523edde updated", ), ), ) configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = ExperimentsApi(api_client) response = api_instance.patch_subject_type(subject_type_id=EXPERIMENT_SUBJECT_TYPE_DATA_ID, body=body) print(response) ``` #### 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_BEARER_TOKEN="" python3 "example.py" ##### ```ruby # Patch subject type returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] end api_instance = DatadogAPIClient::V2::ExperimentsAPI.new # there is a valid "experiment_subject_type" in the system EXPERIMENT_SUBJECT_TYPE_DATA_ID = ENV["EXPERIMENT_SUBJECT_TYPE_DATA_ID"] body = DatadogAPIClient::V2::ExperimentsPatchSubjectTypeV2Request.new({ data: DatadogAPIClient::V2::ExperimentsPatchSubjectTypeV2RequestData.new({ type: DatadogAPIClient::V2::ExperimentsSubjectTypeV2DTODataType::SUBJECT_TYPES, attributes: DatadogAPIClient::V2::ExperimentsPatchSubjectTypeV2RequestDataAttributes.new({ name: "ex-14bb9543f523edde updated", }), }), }) p api_instance.patch_subject_type(EXPERIMENT_SUBJECT_TYPE_DATA_ID, 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_BEARER_TOKEN="" rb "example.rb" ##### ```rust // Patch subject type returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_experiments::ExperimentsAPI; use datadog_api_client::datadogV2::model::ExperimentsPatchSubjectTypeV2Request; use datadog_api_client::datadogV2::model::ExperimentsPatchSubjectTypeV2RequestData; use datadog_api_client::datadogV2::model::ExperimentsPatchSubjectTypeV2RequestDataAttributes; use datadog_api_client::datadogV2::model::ExperimentsSubjectTypeV2DTODataType; #[tokio::main] async fn main() { // there is a valid "experiment_subject_type" in the system let experiment_subject_type_data_id = uuid::Uuid::parse_str(&std::env::var("EXPERIMENT_SUBJECT_TYPE_DATA_ID").unwrap()) .expect("Invalid UUID"); let body = ExperimentsPatchSubjectTypeV2Request::new(ExperimentsPatchSubjectTypeV2RequestData::new( ExperimentsPatchSubjectTypeV2RequestDataAttributes::new() .name("ex-14bb9543f523edde updated".to_string()), ExperimentsSubjectTypeV2DTODataType::SUBJECT_TYPES, )); let configuration = datadog::Configuration::new(); let api = ExperimentsAPI::with_config(configuration); let resp = api .patch_subject_type(experiment_subject_type_data_id.clone(), 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 {% /tab %}