Skip to main content
PATCH
Update a program (PATCH)

Authorizations

x-access-token
string
header
required

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

Path Parameters

orgId
string
required

Your organization ID. Any other organization returns 404.

programId
string<uuid>
required

The Awards program ID.

Body

application/json
name
string
Required string length: 1 - 255
nomenclature
enum<string>
Available options:
awards,
grants,
scholarships
description
string | null
slug
string

Defaults to one derived from name on create.

Required string length: 1 - 255
status
enum<string>

Update only.

Available options:
draft,
open,
reviewing,
closed,
archived
year
integer | null
deadline
string<date-time> | null
collects_fees
boolean

Update only.

submitter_editing_policy
enum<string>
Available options:
never,
while_open,
while_open_after_payment
notify_on_submitter_edit
boolean
default_submission_status
enum<string> | null

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

Available options:
submitted,
under_review,
accepted,
rejected,
,
null

Response

Program updated

data
object