Patch Assignment Source

PATCH /console/v1/experiments/assignment_source/{name}

Try it

Patch Assignment Source

cURL

curl --request PATCH \
  --url https://statsigapi.net/console/v1/experiments/assignment_source/{name} \
  --header 'Content-Type: application/json' \
  --header 'STATSIG-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "isVerified": true,
  "tags": [
    "<string>"
  ],
  "timestampColumn": "<string>",
  "experimentIDColumn": "<string>",
  "groupIDColumn": "<string>",
  "idTypeMapping": [
    {
      "statsigUnitID": "<string>",
      "column": "<string>"
    }
  ],
  "isReadOnly": true,
  "owner": {
    "ownerID": "user123",
    "ownerType": "USER",
    "ownerName": "John Doe",
    "ownerEmail": "[e-mail]"
  }
}
'

200

{
  "message": "Assignment Source updated successfully",
  "data": {
    "name": "exposures3",
    "description": "qweqwe",
    "tags": [],
    "sql": "SELECT * FROM shoppy-sales.experiment_data.exposures",
    "timestampColumn": "ts",
    "groupIDColumn": "group_id",
    "experimentIDColumn": "experiment_name",
    "idTypeMapping": [
      {
        "statsigUnitID": "stableID",
        "column": "user_id"
      }
    ]
  }
}

Authorizations

STATSIG-API-KEY · string · header · required

Headers

x-respect-review-settings · string

Optional header to respect review settings for mutation endpoints.

Path Parameters

name · string · required

Name of the assignment source

Body

application/json

name · string

Unique identifier for the assignment source.

description · string

Detailed context and purpose of the assignment source.

isVerified · boolean

Marks the assignment source as verified for internal trustworthiness.

tags · string[]

Tags for categorization and search.

timestampColumn · string

Column name representing the timestamp of assignments.

experimentIDColumn · string

Column name for the experiment ID associated with the assignments.

groupIDColumn · string

Column name for the group ID linked to the assignments.

idTypeMapping · object[]

Mappings of Statsig units to their respective columns.

Show child attributes

idTypeMapping. statsigUnitID · string · required

ID for the Statsig unit.

idTypeMapping. column · string · required

Column name associated with the ID type mapping.

isReadOnly · boolean

Specifies if the source can only be edited via the Console API.

owner · object

Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.

Show child attributes

owner. ownerID · string

ID of the owner

Example:

"abc123"

owner. ownerType · string

Type of the owner (e.g., SDK_KEY or USER)

Example:

"USER"

owner. ownerName · string

The name of the owner. This field is optional.

Example:

"John Doe"

owner. ownerEmail · string

The email of the owner. This field is optional.

Example:

{
  "ownerID": "user123",
  "ownerType": "USER",
  "ownerName": "John Doe",
  "ownerEmail": "[e-mail]"
}

Response

200

application/json

Patch Assignment Source response

message · string · required

A simple string explaining the result of the operation.

data · object · required

A single result.

Show child attributes

data. name · string · required

Unique identifier for the assignment source.

data. description · string · required

Detailed context and purpose of the assignment source.

data. tags · string[] · required

Tags for categorization and search.

data. sql · string · required

SQL query defining the data source for assignments.

data. timestampColumn · string · required

Column name representing the timestamp of assignments.

data. experimentIDColumn · string · required

Column name for the experiment ID associated with the assignments.

data. groupIDColumn · string · required

Column name for the group ID linked to the assignments.

data. idTypeMapping · object[] · required

Mappings of Statsig units to their respective columns.

Show child attributes

data.idTypeMapping. statsigUnitID · string · required

ID for the Statsig unit.

data.idTypeMapping. column · string · required

Column name associated with the ID type mapping.

data. isVerified · boolean

Marks the assignment source as verified for internal trustworthiness.

data. isReadOnly · boolean

Specifies if the source can only be edited via the Console API.

data. owner · object

Schema for owner data including ID, type, name. Note that if Entity is created by CONSOLE API, owner will be undefined.

Show child attributes

data.owner. ownerID · string

ID of the owner

Example:

"abc123"

data.owner. ownerType · string

Type of the owner (e.g., SDK_KEY or USER)

Example:

"USER"

data.owner. ownerName · string

The name of the owner. This field is optional.

Example:

"John Doe"

data.owner. ownerEmail · string

The email of the owner. This field is optional.

Example:

{
  "ownerID": "user123",
  "ownerType": "USER",
  "ownerName": "John Doe",
  "ownerEmail": "[e-mail]"
}