Skip to main content
POST
Add a new recipient during participation intake

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.

lock_version
integer
required
Required range: x >= 1
Example:

42

display_name
string
required
Required string length: 1 - 255
Example:

"Jane Recipient"

idempotency_key
string
required
Required string length: 1 - 255
Example:

"intake-recipient-120-001"

fields

Current recipient field keys to values, with at most 100 entries. Discover types/options/required fields through overview.intake_fields. Unknown keys are ignored. Site/cohort source fields are populated from the check. Dates use YYYY-MM-DD, numeric fields accept numbers, select/radio values must match options and checkbox fields require arrays.

sp_num
Required range: x >= 0
sp_amount
Required range: x >= 0
email
string<email> | null
Maximum string length: 255
waiting_days
integer | null

Whole days waiting; do not combine a non-null value with waiting_since.

Required range: 0 <= x <= 365000
waiting_since
string<date> | null

Waiting start date, no later than today in the organization timezone; do not combine with waiting_days.

tags
string[]
Maximum array length: 100

Tag name without commas.

Maximum string length: 255

Response

Existing new-recipient request replayed for this check.

created
boolean
required
entity
object | null
required
session
object
required