Skip to main content
PATCH
/
v4
/
question-sets
/
{question_set_id}
Python
import os
from scale_gp import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
question_set = client.question_sets.update(
    question_set_id="question_set_id",
)
print(question_set.id)
{
  "name": "<string>",
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "account_id": "<string>",
  "created_by_user_id": "<string>",
  "created_by_identity_type": "user",
  "question_id_to_config": {},
  "instructions": "<string>",
  "archived_at": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

Path Parameters

question_set_id
string
required

Body

application/json
name
string
instructions
string

Instructions to answer questions

question_ids
string[]

IDs of questions in the question set

restore
boolean
default:false

Set to true to restore the entity from the database.

Response

Successful Response

name
string
required
id
string
required

The unique identifier of the entity.

created_at
string<date-time>
required

The date and time when the entity was created in ISO format.

account_id
string
required

The ID of the account that owns the given entity.

created_by_user_id
string
required

The user who originally created the entity.

created_by_identity_type
enum<string>
required

The type of identity that created the entity.

Available options:
user,
service_account
question_id_to_config
Question Id To Config · object

Specifies additional configurations to use for specific questions in the context of the question set. For example, {<question_a_id>: {required: true}, <question_b_id>: {required: true}} sets two questions as required.

instructions
string

Instructions to answer questions

archived_at
string<date-time>

The date and time when the entity was archived in ISO format.