Skip to content

Add, edit, archive or restore a bank question

POST/v1/organization/{orgId}/learning/workspace/question-bank/manage

US Region: https://public-api.sessionboard.com · EU Region: https://public-api-eu.sessionboard.com

create adds a question (question, a question block with its answers, and up to 10 tags). update changes a question's block, its tags or both (itemId). archive takes a question out of future draws and restore puts it back. A quiz that already drew a question keeps its copy until its course is published again. The token's user needs the Lessons update permission. Requires write:learning; refused for a key restricted to particular events. Also at POST /v1/learning/workspace/question-bank/manage.

Request example

Terminal window
curl --request POST \
--url 'https://public-api.sessionboard.com/v1/organization/{orgId}/learning/workspace/question-bank/manage' \
--header 'x-access-token: <api-token>' \
--header 'Content-Type: application/json' \
--data '{
"action": "create",
"itemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"question": {},
"tags": [
"<string>"
]
}'

Try it

Authorization

Your token stays in this page. It is sent only to the region above and is never saved; it is gone when you leave or reload the page.

Path parameters
Body application/json
POST

Authorizations

  • x-access-tokenstringheader

    Organization API token. Generate from Organization Settings → API Tokens.

  • AuthorizationBearer <token>headeror

    OAuth 2.1 access token. Obtained via the OAuth PKCE flow at /oauth/token.

Send one of these. See Authentication.

Path parameters

  • orgIdstringpathrequired

    Your organization ID. Any other organization returns 404.

Request body

application/jsonrequired

  • actionstringrequired
    Allowed values
    "create", "update", "archive", "restore"
  • itemIdstring<uuid>

    The bank question. Required for every action except create.

  • questionobject

    A question block (the same shape a quiz page uses), answers included.

  • tagsstring[]
    Max items
    10
{
"action": "create",
"itemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"question": {},
"tags": [
"<string>"
]
}

Responses

200application/json

OK

  • successboolean
  • payloadobject
    Show child attributes
    • itemLearningQuestionBankItem

      A question in the organization's question bank.

      Show child attributes
      • idstring<uuid>
      • questionobject

        The question block, answers included; its id is the bank question's id.

      • question_typestring
      • promptstring

        The prompt as plain text.

      • tagsstring[]
      • archivedboolean
      • updated_atstring<date-time>

400application/json

A path, query or body value failed validation, or an unknown body property was sent. message names the field. (A source object naming the assistant, with the person's prompt, is accepted on every write and removed before validation.) For an {eventId} path that is not a whole number: error: VALIDATION_ERROR, eventId must be a valid integer.

Gateway errors carry error (a code) and message. Errors from Learning itself carry status, success: false, message, name, and sometimes code (and feature or paused_at).

  • errorstring | object

    The gateway's error code (SCOPE_REQUIRED, ORG_WIDE_TOKEN_REQUIRED, NOT_FOUND, …).

  • messagestring
  • statusinteger
  • successboolean
  • namestring
  • codestring

    FEATURE_NOT_ENABLED, AGENT_WRITES_PAUSED, …

  • featurestring
  • paused_atstring<date-time>

401

Missing, invalid or expired token.

403application/json

  • SCOPE_REQUIRED — the token lacks read:learning (reads) or write:learning (writes). Legacy tokens with no scopes cannot write.
  • ORG_WIDE_TOKEN_REQUIRED — the token is restricted to particular events: "The Learning workspace covers every event and learner in the organization, so this API key (restricted to particular events) cannot use it. Use a key without an event restriction."
  • FEATURE_NOT_ENABLED (feature: lessons_credits) — Learning is not on for the organization.
  • FORBIDDEN — the token's user is not an active member of the organization, or lacks the Lessons permission the operation needs.

Gateway errors carry error (a code) and message. Errors from Learning itself carry status, success: false, message, name, and sometimes code (and feature or paused_at).

  • errorstring | object

    The gateway's error code (SCOPE_REQUIRED, ORG_WIDE_TOKEN_REQUIRED, NOT_FOUND, …).

  • messagestring
  • statusinteger
  • successboolean
  • namestring
  • codestring

    FEATURE_NOT_ENABLED, AGENT_WRITES_PAUSED, …

  • featurestring
  • paused_atstring<date-time>

404application/json

orgId is not your organization (error: NOT_FOUND, message: Organization not found).

Gateway errors carry error (a code) and message. Errors from Learning itself carry status, success: false, message, name, and sometimes code (and feature or paused_at).

  • errorstring | object

    The gateway's error code (SCOPE_REQUIRED, ORG_WIDE_TOKEN_REQUIRED, NOT_FOUND, …).

  • messagestring
  • statusinteger
  • successboolean
  • namestring
  • codestring

    FEATURE_NOT_ENABLED, AGENT_WRITES_PAUSED, …

  • featurestring
  • paused_atstring<date-time>

429application/json

  • The token's request limit (100 requests per 15 minutes per bucket by default — see Rate Limiting). Wait Retry-After seconds.
  • QUOTA_EXCEEDED (writes) — the token's daily write quota (10,000 a day). Resets at midnight UTC.

Gateway errors carry error (a code) and message. Errors from Learning itself carry status, success: false, message, name, and sometimes code (and feature or paused_at).

  • errorstring | object

    The gateway's error code (SCOPE_REQUIRED, ORG_WIDE_TOKEN_REQUIRED, NOT_FOUND, …).

  • messagestring
  • statusinteger
  • successboolean
  • namestring
  • codestring

    FEATURE_NOT_ENABLED, AGENT_WRITES_PAUSED, …

  • featurestring
  • paused_atstring<date-time>
  • Retry-Afterintegerheader

    Seconds to wait before retrying.

Response examples

{
"success": true,
"payload": {
"item": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"question": {},
"question_type": "<string>",
"prompt": "<string>",
"tags": [
"<string>"
],
"archived": true,
"updated_at": "2026-01-15T09:30:00Z"
}
}
}