POST
/
v4
/
question-sets
JavaScript
import SGPClient from 'sgp';

const client = new SGPClient({
  apiKey: 'My API Key',
});

const questionSet = await client.questionSets.create({
  account_id: 'account_id',
  name: 'name',
  question_ids: ['string'],
});

console.log(questionSet.id);
{
  "name": "<string>",
  "question_id_to_config": {},
  "instructions": "<string>",
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "account_id": "<string>",
  "created_by_user_id": "<string>",
  "created_by_identity_type": "user",
  "archived_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Headers

​
x-selected-account-id
string

Body

application/json
​
name
string
required
​
account_id
string
required

The ID of the account that owns the given entity.

​
question_ids
string[]
required

IDs of questions in the question set

​
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

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
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.