This product is not supported for your selected Datadog site. ().

Patch subject type

PATCH https://api.ap1.datadoghq.com/api/v2/experiments/subject-types/{subject_type_id}https://api.ap2.datadoghq.com/api/v2/experiments/subject-types/{subject_type_id}https://api.datadoghq.eu/api/v2/experiments/subject-types/{subject_type_id}https://api.ddog-gov.com/api/v2/experiments/subject-types/{subject_type_id}https://api.us2.ddog-gov.com/api/v2/experiments/subject-types/{subject_type_id}https://api.uk1.datadoghq.com/api/v2/experiments/subject-types/{subject_type_id}https://api.datadoghq.com/api/v2/experiments/subject-types/{subject_type_id}https://api.us3.datadoghq.com/api/v2/experiments/subject-types/{subject_type_id}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 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)

Expand All

Field

Type

Description

data [required]

object

JSON:API resource containing the subject type identity and fields.

attributes [required]

object

Fields supplied to update the subject type.

migration_metadata

Metadata retained for resources imported from another system.

name

string

Display name of the subject type.

product_analytics_attribute

string

Product Analytics attribute used to identify subjects of this type.

warehouse_column_names

[string]

Warehouse columns that identify subjects of this type.

id

string

ID of the subject type.

type [required]

enum

Subject types resource type. Allowed enum values: subject-types

default: subject-types

{
  "data": {
    "type": "subject-types",
    "attributes": {
      "name": "ex-14bb9543f523edde updated"
    }
  }
}

Response

OK

Response containing the subject type.

Expand All

Field

Type

Description

data [required]

object

JSON:API resource containing the subject type identity and fields.

attributes

object

Details of the subject type.

created_at

date-time

Time when this resource was created.

experiment_count

int64

Number of experiments that reference this resource.

exposure_source_count

int64

Number of exposure sources that reference this subject type.

is_default

boolean

Whether this is the organization's default subject type.

metric_sql_model_count

int64

Number of metric SQL models that reference this subject type.

migration_metadata

Metadata retained for resources imported from another system.

name

string

Display name of the subject type.

product_analytics_attribute

string

Product Analytics attribute used to identify subjects of this type.

protocol_count

int64

Number of protocols that reference this subject type.

updated_at

date-time

Time when this resource was last updated.

warehouse_column_names

[string]

Warehouse columns that identify subjects of this type.

id [required]

uuid

ID of the subject type.

type [required]

enum

Subject types resource type. Allowed enum values: subject-types

default: subject-types

{
  "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"
  }
}

Malformed subject type ID, malformed body, or no updatable field supplied.

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Missing or invalid authentication.

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Authenticated caller lacks the product_analytics_settings_write permission.

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

No subject type with this ID exists for the organization.

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

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="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.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