---
title: "Patch Assignment Source"
method: PATCH
path: "/console/v1/experiments/assignment_source/{name}"
tags: ["Experiments", "Experiments (Warehouse Native)"]
---

# Patch Assignment Source

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

## Path parameters

- `name` string, required

## Request body

- AssignmentSourcePartialUpdateDto
  - `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.
  - `sql` unknown
  - `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.
  - `groupNameColumn` string — Optional column name for the group name linked to the assignments.
  - `idTypeMapping` object[] — Mappings of Statsig units to their respective columns.
    - `statsigUnitID` string, required — ID for the Statsig unit.
    - `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, nullable — Schema for owner data including ID, type, name.
    - `ownerID` string — ID of the owner
    - `ownerType` string — Type of the owner (e.g., SDK_KEY or USER)
    - `ownerName` string — The name of the owner. This field is optional.
    - `ownerEmail` string — The email of the owner. This field is optional.
  - `team` string, nullable — Optional field indicating the team name responsible for the assignment source, aiding in accountability and management.
  - `teamID` string, nullable — Optional field indicating the team ID responsible for the assignment source, aiding in accountability and management.
  - `scheduledReloadHour` integer, nullable — Optional field indicating what UTC hour to run a scheduled scan for the assignment source.
  - `dryRun` boolean — Skips persisting the assignment source (used to validate that inputs are correct)

## Response `200`

Patch Assignment Source response

- object
  - `message` string, required — A simple string explaining the result of the operation.
  - `data` object, required — A single result.
    - `name` string, required — Unique identifier for the assignment source.
    - `description` string, required — Detailed context and purpose of the assignment source.
    - `isVerified` boolean — Marks the assignment source as verified for internal trustworthiness.
    - `tags` string[], required — Tags for categorization and search.
    - `sql` string, required — SQL query defining the data source for assignments.
    - `timestampColumn` string, required — Column name representing the timestamp of assignments.
    - `experimentIDColumn` string, required — Column name for the experiment ID associated with the assignments.
    - `groupIDColumn` string, required — Column name for the group ID linked to the assignments.
    - `groupNameColumn` string — Optional column name for the group name linked to the assignments.
    - `idTypeMapping` object[], required — Mappings of Statsig units to their respective columns.
      - `statsigUnitID` string, required — ID for the Statsig unit.
      - `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, nullable — Schema for owner data including ID, type, name.
      - `ownerID` string — ID of the owner
      - `ownerType` string — Type of the owner (e.g., SDK_KEY or USER)
      - `ownerName` string — The name of the owner. This field is optional.
      - `ownerEmail` string — The email of the owner. This field is optional.
    - `team` string, nullable — Optional field indicating the team name responsible for the assignment source, aiding in accountability and management.
    - `teamID` string, nullable — Optional field indicating the team ID responsible for the assignment source, aiding in accountability and management.
    - `scheduledReloadHour` integer, nullable — Optional field indicating what UTC hour to run a scheduled scan for the assignment source.

## Other responses

- `400` — Invalid request. Please check the request input and try again.
- `401` — This endpoint only accepts an active CONSOLE key, but an invalid key was sent. Key: console-xxxXXXxxxXXXxxx
- `404` — Not Found. The requested resource could not be found.

---

[API](https://skmtc.net/statsig/apis/console-api.md) · [All operations](https://skmtc.net/statsig/apis/console-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/statsig/console-api/versions/3189f450c93b/schema)
