Update the setup answers

PUT/v1/organization/{orgId}/awards/workspace/profile

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

Saves who the awards are for and what is being awarded. Only the fields you send change; awarding: "" clears it. finished: true marks setup done (the first time only; false does not undo it). Programs created afterwards take their defaults from the audience; existing programs do not change. Sends nothing. The token's user must be an organization admin. Requires write:awards. Refused for a key restricted to particular events. Also at PUT /v1/awards/workspace/profile.

Request example

cURL

curl --request PUT \
  --url 'https://public-api.sessionboard.com/v1/organization/{orgId}/awards/workspace/profile' \
  --header 'x-access-token: <api-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "audience": "members",
  "awarding": "<string>",
  "finished": true,
  "source": {
    "client": "<string>",
    "version": "<string>",
    "run_id": "<string>",
    "prompt": "<string>"
  }
}'

JavaScript

const response = await fetch('https://public-api.sessionboard.com/v1/organization/{orgId}/awards/workspace/profile', {
  method: 'PUT',
  headers: {
    "x-access-token": "<api-token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "audience": "members",
    "awarding": "<string>",
    "finished": true,
    "source": {
      "client": "<string>",
      "version": "<string>",
      "run_id": "<string>",
      "prompt": "<string>"
    }
  }),
});

const data = await response.json();
console.log(data);

Python

import requests

response = requests.request(
    "PUT",
    "https://public-api.sessionboard.com/v1/organization/{orgId}/awards/workspace/profile",
    headers={
        "x-access-token": "<api-token>",
        "Content-Type": "application/json"
    },
    json={
        "audience": "members",
        "awarding": "<string>",
        "finished": True,
        "source": {
            "client": "<string>",
            "version": "<string>",
            "run_id": "<string>",
            "prompt": "<string>"
        }
    },
)

print(response.json())

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://public-api.sessionboard.com/v1/organization/{orgId}/awards/workspace/profile",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_POSTFIELDS => '{
  "audience": "members",
  "awarding": "<string>",
  "finished": true,
  "source": {
    "client": "<string>",
    "version": "<string>",
    "run_id": "<string>",
    "prompt": "<string>"
  }
}',
    CURLOPT_HTTPHEADER => [
        "x-access-token: <api-token>",
        "Content-Type: application/json",
    ],
]);

$response = curl_exec($curl);
curl_close($curl);

echo $response;

Go

package main

import (
  "fmt"
  "io"
  "net/http"
  "strings"
)

func main() {
  req, _ := http.NewRequest("PUT", "https://public-api.sessionboard.com/v1/organization/{orgId}/awards/workspace/profile", strings.NewReader(`{
  "audience": "members",
  "awarding": "<string>",
  "finished": true,
  "source": {
    "client": "<string>",
    "version": "<string>",
    "run_id": "<string>",
    "prompt": "<string>"
  }
}`))
  req.Header.Add("x-access-token", "<api-token>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(string(body))
}

Java

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://public-api.sessionboard.com/v1/organization/{orgId}/awards/workspace/profile"))
    .header("x-access-token", "<api-token>")
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString("{\n  \"audience\": \"members\",\n  \"awarding\": \"<string>\",\n  \"finished\": true,\n  \"source\": {\n    \"client\": \"<string>\",\n    \"version\": \"<string>\",\n    \"run_id\": \"<string>\",\n    \"prompt\": \"<string>\"\n  }\n}"))
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

Try it

RegionUS Region — https://public-api.sessionboard.comEU Region — https://public-api-eu.sessionboard.com

Authorization

Send asAPI token (x-access-token)OAuth access token (Bearer)

Token

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

orgId*

Body application/json

{ "audience": "members", "awarding": "<string>", "finished": true, "source": { "client": "<string>", "version": "<string>", "run_id": "<string>", "prompt": "<string>" } }

PUT

Send request

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/json

• audiencestring

  Who the awards are for: members (member recognition, fellows, volunteers, scholarships), customers (customer and partner awards), industry (an open call across your field) or employees (internal recognition). Sets a new program's default nomination mode and starter categories.

  Allowed values

  "members", "customers", "industry", "employees"

• awardingstring

  What is being awarded, in a few words. An empty string clears it.

  Max length

  300

• finishedboolean

  true marks setup finished.

• sourceAwardsWorkspaceSource

  Optional on every write: which assistant is calling and what the person asked it. Recorded with the change in the organization's activity and on any approval request; never stored on the program.

  Show child attributes

  • clientstring

    The assistant's client name (for example Claude or ChatGPT).

  • versionstring
  • run_idstring

    Your own id for the conversation.

  • promptstring

    What the person asked the assistant.

    Max length

    2000

Example

{
  "audience": "members",
  "awarding": "<string>",
  "finished": true,
  "source": {
    "client": "<string>",
    "version": "<string>",
    "run_id": "<string>",
    "prompt": "<string>"
  }
}

Responses

200application/json

OK

• successboolean
• payloadobject
  Show child attributes

  • profileAwardsWorkspaceProfile
    Show child attributes

    • audiencestring | any | null
    • audience_labelstring | null

      Example

      "Members"

    • awardingstring | null

      What is being awarded.

    • finishedboolean

      Setup is finished.

    • finished_atstring<date-time> | null

400application/json

VALIDATION_ERROR: the body or a path id does not match the schema. Unknown body fields are refused and named in the message; source is always accepted.

Error body for the Awards workspace operations.

• errorstringrequired

  Allowed values

  "VALIDATION_ERROR", "SCOPE_REQUIRED", "ORG_WIDE_TOKEN_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "QUOTA_EXCEEDED"

• messagestringrequired
• codestring

  A more specific reason, when there is one (trial_ended, plan_ended).

401

Missing, invalid or expired token.

403application/json

• SCOPE_REQUIRED: the token lacks write:awards. Legacy tokens with no scopes cannot write.
• ORG_WIDE_TOKEN_REQUIRED: the key is restricted to particular events. The Awards workspace covers every awards program in the organization, so use a key without an event restriction.
• FORBIDDEN with code: trial_ended or code: plan_ended: the organization's self-serve Awards plan is read-only (the trial ended, or the plan was canceled or is unpaid). Everything can still be read; choose a plan to make changes.
• FORBIDDEN with no code: the token's user is not an active member of the organization, lacks the Awards permission the operation needs, does not manage the program, or (for the setup answers) is not an organization admin.

These operations do not return enterprise_only; the Enterprise-only items are listed by GET /v1/organization/{orgId}/awards/workspace/enterprise.

Error body for the Awards workspace operations.

• errorstringrequired

  Allowed values

  "VALIDATION_ERROR", "SCOPE_REQUIRED", "ORG_WIDE_TOKEN_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "QUOTA_EXCEEDED"

• messagestringrequired
• codestring

  A more specific reason, when there is one (trial_ended, plan_ended).

404application/json

NOT_FOUND: orgId is not the token's organization.

Error body for the Awards workspace operations.

• errorstringrequired

  Allowed values

  "VALIDATION_ERROR", "SCOPE_REQUIRED", "ORG_WIDE_TOKEN_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "QUOTA_EXCEEDED"

• messagestringrequired
• codestring

  A more specific reason, when there is one (trial_ended, plan_ended).

429application/json

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

• responseTooManyRequestsError | AwardsWorkspaceError
  name: TooManyRequestsError (TooManyRequestsError)

  Body of a 429 from the API's own request limits (per token, and per organization and user). Wait Retry-After seconds.

  • statusinteger

    Example

    429

  • successboolean

    Example

    false

  • messagestringrequired

    Example

    "Error while trying to reach the endpoint: Too many requests"

  • namestringrequired

    Allowed values

    "TooManyRequestsError"

  Option 2 (AwardsWorkspaceError)

  Error body for the Awards workspace operations.

  • errorstringrequired

    Allowed values

    "VALIDATION_ERROR", "SCOPE_REQUIRED", "ORG_WIDE_TOKEN_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "QUOTA_EXCEEDED"

  • messagestringrequired
  • codestring

    A more specific reason, when there is one (trial_ended, plan_ended).

• Retry-Afterintegerheader

  Seconds to wait before retrying.

Response examples

200

{
  "success": true,
  "payload": {
    "profile": {
      "audience": "members",
      "audience_label": "Members",
      "awarding": "<string>",
      "finished": true,
      "finished_at": "2026-01-15T09:30:00Z"
    }
  }
}

400

{
  "error": "VALIDATION_ERROR",
  "message": "Error on body parameter: data should NOT have additional properties: \"winners\""
}

403 · Token lacks the write scope

{
  "error": "SCOPE_REQUIRED",
  "message": "This operation requires the 'write:awards' scope."
}

403 · Key restricted to particular events

{
  "error": "ORG_WIDE_TOKEN_REQUIRED",
  "message": "The Awards workspace covers every awards program in the organization, so this API key (restricted to particular events) cannot use it. Use a key without an event restriction."
}

403 · The self-serve trial has ended

{
  "error": "FORBIDDEN",
  "message": "Your Awards trial has ended. Choose a plan to keep going; everything you made is still here.",
  "code": "trial_ended"
}

403 · The self-serve plan is read-only

{
  "error": "FORBIDDEN",
  "message": "Your Awards plan has ended, so the workspace is read-only. Choose a plan to pick up where you left off.",
  "code": "plan_ended"
}

403 · The token's user does not manage the program

{
  "error": "FORBIDDEN",
  "message": "User is not a manager of this program"
}

404

{
  "error": "NOT_FOUND",
  "message": "Organization not found"
}

429

{
  "status": 429,
  "success": false,
  "message": "Error while trying to reach the endpoint: Too many requests",
  "name": "TooManyRequestsError"
}