Update a program (PATCH)

PATCH/v1/organization/{orgId}/awards/programs/{programId}

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

Fields you omit keep their stored value. PUT and PATCH behave the same: send only the fields you are changing. Requires the write:awards scope.

Request example

cURL

curl --request PATCH \
  --url 'https://public-api.sessionboard.com/v1/organization/{orgId}/awards/programs/{programId}' \
  --header 'x-access-token: <api-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "nomenclature": "awards",
  "description": "<string>",
  "slug": "<string>",
  "status": "draft",
  "year": 123,
  "deadline": "2026-01-15T09:30:00Z",
  "collects_fees": true,
  "submitter_editing_policy": "never",
  "notify_on_submitter_edit": true,
  "default_submission_status": "submitted"
}'

JavaScript

const response = await fetch('https://public-api.sessionboard.com/v1/organization/{orgId}/awards/programs/{programId}', {
  method: 'PATCH',
  headers: {
    "x-access-token": "<api-token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "name": "<string>",
    "nomenclature": "awards",
    "description": "<string>",
    "slug": "<string>",
    "status": "draft",
    "year": 123,
    "deadline": "2026-01-15T09:30:00Z",
    "collects_fees": true,
    "submitter_editing_policy": "never",
    "notify_on_submitter_edit": true,
    "default_submission_status": "submitted"
  }),
});

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

Python

import requests

response = requests.request(
    "PATCH",
    "https://public-api.sessionboard.com/v1/organization/{orgId}/awards/programs/{programId}",
    headers={
        "x-access-token": "<api-token>",
        "Content-Type": "application/json"
    },
    json={
        "name": "<string>",
        "nomenclature": "awards",
        "description": "<string>",
        "slug": "<string>",
        "status": "draft",
        "year": 123,
        "deadline": "2026-01-15T09:30:00Z",
        "collects_fees": True,
        "submitter_editing_policy": "never",
        "notify_on_submitter_edit": True,
        "default_submission_status": "submitted"
    },
)

print(response.json())

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://public-api.sessionboard.com/v1/organization/{orgId}/awards/programs/{programId}",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "PATCH",
    CURLOPT_POSTFIELDS => '{
  "name": "<string>",
  "nomenclature": "awards",
  "description": "<string>",
  "slug": "<string>",
  "status": "draft",
  "year": 123,
  "deadline": "2026-01-15T09:30:00Z",
  "collects_fees": true,
  "submitter_editing_policy": "never",
  "notify_on_submitter_edit": true,
  "default_submission_status": "submitted"
}',
    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("PATCH", "https://public-api.sessionboard.com/v1/organization/{orgId}/awards/programs/{programId}", strings.NewReader(`{
  "name": "<string>",
  "nomenclature": "awards",
  "description": "<string>",
  "slug": "<string>",
  "status": "draft",
  "year": 123,
  "deadline": "2026-01-15T09:30:00Z",
  "collects_fees": true,
  "submitter_editing_policy": "never",
  "notify_on_submitter_edit": true,
  "default_submission_status": "submitted"
}`))
  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/programs/{programId}"))
    .header("x-access-token", "<api-token>")
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\n  \"name\": \"<string>\",\n  \"nomenclature\": \"awards\",\n  \"description\": \"<string>\",\n  \"slug\": \"<string>\",\n  \"status\": \"draft\",\n  \"year\": 123,\n  \"deadline\": \"2026-01-15T09:30:00Z\",\n  \"collects_fees\": true,\n  \"submitter_editing_policy\": \"never\",\n  \"notify_on_submitter_edit\": true,\n  \"default_submission_status\": \"submitted\"\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*

programId*

Body application/json

{ "name": "<string>", "nomenclature": "awards", "description": "<string>", "slug": "<string>", "status": "draft", "year": 123, "deadline": "2026-01-15T09:30:00Z", "collects_fees": true, "submitter_editing_policy": "never", "notify_on_submitter_edit": true, "default_submission_status": "submitted" }

PATCH

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.

• programIdstring<uuid>pathrequired

  The Awards program ID.

Request body

application/jsonrequired

• namestring

  Min length

  1

  Max length

  255

• nomenclaturestring

  Allowed values

  "awards", "grants", "scholarships"

• descriptionstring | null
• slugstring

  Defaults to one derived from name on create.

  Min length

  1

  Max length

  255

• statusstring

  Update only.

  Allowed values

  "draft", "open", "reviewing", "closed", "archived"

• yearinteger | null
• deadlinestring<date-time> | null
• collects_feesboolean

  Update only.

• submitter_editing_policystring

  Allowed values

  "never", "while_open", "while_open_after_payment"

• notify_on_submitter_editboolean
• default_submission_statusstring | null

  Status a new submission starts in. Empty string or null clears it.

  Allowed values

  "submitted", "under_review", "accepted", "rejected", "", null

Example

{
  "name": "<string>",
  "nomenclature": "awards",
  "description": "<string>",
  "slug": "<string>",
  "status": "draft",
  "year": 123,
  "deadline": "2026-01-15T09:30:00Z",
  "collects_fees": true,
  "submitter_editing_policy": "never",
  "notify_on_submitter_edit": true,
  "default_submission_status": "submitted"
}

Responses

200application/json

Program updated

• dataAwardsProgram
  Show child attributes

  • idstring<uuid>
  • org_idstring
  • namestring
  • slugstring
  • nomenclaturestring

    Allowed values

    "awards", "grants", "scholarships"

  • descriptionstring | null
  • statusstring

    Allowed values

    "draft", "open", "reviewing", "closed", "archived"

  • yearinteger | null
  • deadlinestring<date-time> | null
  • collects_feesboolean
  • pricing_typestring | null
  • base_feenumber | null
  • submitter_editing_policystring

    Allowed values

    "never", "while_open", "while_open_after_payment"

  • notify_on_submitter_editboolean
  • created_atstring<date-time>
  • updated_atstring<date-time>

400application/json

Invalid body or id

• errorstring

  Allowed values

  "VALIDATION_ERROR", "SCOPE_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT"

• messagestring

401

Missing or invalid token

403application/json

Token lacks write:awards

• errorstring

  Allowed values

  "VALIDATION_ERROR", "SCOPE_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT"

• messagestring

404application/json

Not found — also returned for any id belonging to another organization

• errorstring

  Allowed values

  "VALIDATION_ERROR", "SCOPE_REQUIRED", "FORBIDDEN", "NOT_FOUND", "CONFLICT"

• messagestring

Response examples

200

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "org_id": "<string>",
    "name": "2027 Excellence Awards",
    "slug": "2027-excellence-awards",
    "nomenclature": "awards",
    "description": "<string>",
    "status": "draft",
    "year": 123,
    "deadline": "2026-01-15T09:30:00Z",
    "collects_fees": true,
    "pricing_type": "<string>",
    "base_fee": 123.45,
    "submitter_editing_policy": "never",
    "notify_on_submitter_edit": true,
    "created_at": "2026-01-15T09:30:00Z",
    "updated_at": "2026-01-15T09:30:00Z"
  }
}

400

{
  "error": "VALIDATION_ERROR",
  "message": "\"name\" is not allowed to be empty"
}

403

{
  "error": "SCOPE_REQUIRED",
  "message": "Token missing required scope: write:awards"
}

404

{
  "error": "NOT_FOUND",
  "message": "Not found"
}