Skip to main content
POST
Create a public recipient/entity

Path Parameters

client_id
integer
required

Client id that owns the target program and new entity.

program_id
integer
required

Program id whose HysForm determines the public entity fields and whose counter is incremented.

session_id
string
required

Optional existing frontend session. When valid, successful creation binds the new recipient to this session for a subsequent public upload.

Body

application/json

Public entity fields. Known service-level fields are documented explicitly; all configured HysForm field keys may also be supplied and are stored in json_fields after field-type normalization.

sp_num
string | null

Sponsorship number or goal. Validator rule is dynamic: nullable|integer for number programs, nullable|numeric for contribution/funding programs.

Example:

"1000"

sp_amount
string | null

Sponsorship amount stored on the entity after trimming.

Example:

"35.00"

email
string<email> | null

Optional entity email. Validator rule: nullable|email.

Example:

"recipient@example.org"

tags
string[] | null

Optional tags; the service joins them with commas and synchronizes client tags; tag names cannot contain commas.

Example:
is_visible
boolean | null

Optional public visibility flag; defaults to visible when omitted.

Example:

true

Response

Entity created.

status
string
Example:

"success"

message
string
Example:

"Entity added successfully"

entity_id
integer
Example:

4711

entity
Entity · object

A sponsorship recipient — the 'who/what' a donor sponsors. Entities can represent children, families, animals, projects, or any other sponsorable thing depending on the program. Like donors, entities have standardized columns plus arbitrary json_fields defined by the program's Hysform. Donations target an entity through the historical donation.designation column.