Close nominations

POST/v1/organization/{orgId}/awards/workspace/programs/{programId}/close

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

Closes nominations now and starts review: the nomination window ends, the review pass starts now and runs until its current end date (or three weeks from now when that has passed), and the program's status becomes reviewing. Unfinished nominations stay drafts. Sends nothing. No request body. Requires write:awards; the token's user needs the Awards update permission and must manage the program. Refused for a key restricted to particular events. Also at POST /v1/awards/workspace/programs/{programId}/close.

Request example

curl --request POST \
  --url 'https://public-api.sessionboard.com/v1/organization/{orgId}/awards/workspace/programs/{programId}/close' \
  --header 'x-access-token: <api-token>'

const response = await fetch('https://public-api.sessionboard.com/v1/organization/{orgId}/awards/workspace/programs/{programId}/close', {
  method: 'POST',
  headers: {
    "x-access-token": "<api-token>"
  },
});

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

import requests

response = requests.request(
    "POST",
    "https://public-api.sessionboard.com/v1/organization/{orgId}/awards/workspace/programs/{programId}/close",
    headers={
        "x-access-token": "<api-token>"
    },
)

print(response.json())

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://public-api.sessionboard.com/v1/organization/{orgId}/awards/workspace/programs/{programId}/close",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "x-access-token: <api-token>",
    ],
]);

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

echo $response;

package main

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

func main() {
  req, _ := http.NewRequest("POST", "https://public-api.sessionboard.com/v1/organization/{orgId}/awards/workspace/programs/{programId}/close", nil)
  req.Header.Add("x-access-token", "<api-token>")

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

  fmt.Println(string(body))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://public-api.sessionboard.com/v1/organization/{orgId}/awards/workspace/programs/{programId}/close"))
    .header("x-access-token", "<api-token>")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();

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

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

Try it

Response headers

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.
programIdstring<uuid>pathrequired
The Awards program ID.

Responses

200`application/json`

successboolean
payloadobject
Show child attributes
- programAwardsWorkspaceProgram
  Show child attributes
  - idstring<uuid>
  - namestring
  - nomenclaturestring
    Allowed values
    "awards", "grants", "scholarships"
  - descriptionstring | null
  - nomination_modestring
    nominate_others: people nominate someone else. self_only: people submit for themselves. Defaults to the audience's mode.
    Allowed values
    "nominate_others", "self_only"
  - statusstring
    Worked out from the dates: open while it is on the Awards Site and its nomination window is running, reviewing after nominations close, closed when it has nominations and every date has passed.
    Allowed values
    "draft", "open", "reviewing", "closed", "archived"
  - decidedboolean
    At least one winner has been picked.
  - roundAwardsWorkspaceRound | any | null
    Show child attributes
    idstring<uuid>
    namestring
    submission_start_datestring<date-time> | null
    submission_end_datestring<date-time> | null
    The nomination deadline.
    review_start_datestring<date-time> | null
    review_end_datestring<date-time> | null
  - roundsinteger
    How many Rounds the program has (one on self-serve).
  - categoriesAwardsWorkspaceCategory[]
    Show child attributes
    idstring<uuid>
    namestring
  - categories_revisionstring
    Send this as baseRevision when replacing the categories.
  - public_urlstring | null
    The program's sign-in page on the Awards Site, once it has been opened. Empty when the Site has no address yet.
  - countsAwardsWorkspaceProgramCounts
    Show child attributes
    submittedinteger
    Submitted nominations.
    draftsinteger
    Nominations started and not submitted.
    reviewersinteger
    scorecardsinteger
    Finished scorecards.
    reviewedinteger
    Submitted nominations with at least one finished scorecard.
    winnersinteger
  - created_atstring<date-time>

400`application/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.

403`application/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).

404`application/json`

NOT_FOUND: orgId is not the token's organization, or the program is not in it.

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

423`application/json`

A person has paused connected assistants for the organization, so writes from the API wait until they resume it in Sessionboard. code is AGENT_WRITES_PAUSED.

Error body for 423.

statusinteger
successboolean
messagestring
namestring
codestring
paused_atstring<date-time>
When assistants were paused.

429`application/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

{
  "success": true,
  "payload": {
    "program": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "nomenclature": "awards",
      "description": "<string>",
      "nomination_mode": "nominate_others",
      "status": "draft",
      "decided": true,
      "round": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "submission_start_date": "2026-01-15T09:30:00Z",
        "submission_end_date": "2026-01-15T09:30:00Z",
        "review_start_date": "2026-01-15T09:30:00Z",
        "review_end_date": "2026-01-15T09:30:00Z"
      },
      "rounds": 123,
      "categories": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>"
        }
      ],
      "categories_revision": "<string>",
      "public_url": "<string>",
      "counts": {
        "submitted": 123,
        "drafts": 123,
        "reviewers": 123,
        "scorecards": 123,
        "reviewed": 123,
        "winners": 123
      },
      "created_at": "2026-01-15T09:30:00Z"
    }
  }
}

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

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

{
  "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."
}

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

{
  "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"
}

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

{
  "error": "NOT_FOUND",
  "message": "Awards Program could not be found"
}

{
  "status": 423,
  "success": false,
  "message": "A person has paused connected assistants in Sessionboard. Ask them to resume it from their workspace before trying again.",
  "name": "AgentWritesPausedError",
  "code": "AGENT_WRITES_PAUSED",
  "paused_at": "2026-11-06T15:04:05.000Z"
}

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

Close nominations

Request example

Try it

Authorizations

Path parameters

Responses

200application/json

400application/json

401

403application/json

404application/json

423application/json

429application/json

Response examples

200`application/json`

400`application/json`

403`application/json`

404`application/json`

423`application/json`

429`application/json`