Skip to main content
POST
Add an existing recipient to a draft check

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

program_id
integer
required

Program whose participation setup, placements and checks are being accessed.

Required range: x >= 1
session_id
integer
required

Participation check ID within this program.

Required range: x >= 1

Body

application/json

Request fields accepted by this operation. Omitted optional properties retain the behavior described above.

entity_id
integer
required

Validation: required|integer|min:1.

Required range: x >= 1
lock_version
integer
required

Validation: required|integer|min:1.

Required range: x >= 1

Response

Add an existing recipient to a draft check response.

id
integer
required
program_id
integer
required
scheduled_for
string<date> | null
required
revision
integer
required
supersedes_session_id
integer | null
required
lock_version
integer
required
partial_reason
string | null
required
source_note
string | null
required
submitted_at
string<date-time> | null
required
voided_at
string<date-time> | null
required
void_reason
string | null
required
available_new_entrants_count
integer
required
period
required
site
required
cohort
required
session_type
string
required
Example:

"roster_verification"

status
enum<string>
required
Available options:
draft,
submitted,
superseded,
voided
series_uuid
string<uuid>
required
primary_evidence_source
enum<string>
required
Available options:
official_record,
headcount,
staff_confirmation,
participant_confirmation,
legacy_import,
other
counts
object
required
observations
object[]
required

Complete roster ordered by display-name snapshot; observation IDs are scoped to this check.