> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.helpyousponsor.com/llms.txt > Use this file to discover all available pages before exploring further. # Create a public recipient/entity > Creates an entity from a public add-recipient form. The controller delegates to `EntityService::createEntity`, which scopes the program by client, validates `sp_num` according to program type, validates optional email format, enforces any unique public field configured on the HysForm, stores remaining request fields in entity `json_fields`, increments the program counter, logs frontend activity, and reloads the entity cache. The route is throttled by `frontend-add-entity` middleware. ## OpenAPI ````yaml post /frontend/add_entity/{client_id}/{program_id}/{session_id} openapi: 3.0.0 info: title: Gratona API description: >- REST API for the Gratona fundraising platform, including donor, donation, sponsorship, program, event, and integration workflows. Endpoints are organized by tag. Most endpoints require either a Passport bearer token or an issued API key — see the Security Schemes section. contact: name: Gratona Engineering url: https://gratona.com email: devs@gratona.com version: 1.0.0 servers: - url: https://api.gratona.com/v1 description: Server Version 1.0.0 security: [] tags: - name: Auth description: >- Login, signup, logout, password reset, and email verification for admin users and donors. - name: Donors description: >- Donor records: CRUD, profile fields, household linkage, search, filters, merge, and duplicate detection. - name: Donations description: >- Individual donation records, recurring commitments, soft credits, refunds, designations, and exports. - name: Sponsorships description: >- Donor-to-entity sponsorship relationships, lifecycle transitions, and sponsorship-specific filters. - name: Entities description: >- Recipient records (children, families, projects, animals, etc.), their status, and entity-level fields. - name: Programs description: >- Program / campaign configuration: hierarchy, settings, and program-level metadata. - name: Forms description: >- Custom form builder (HysForm), form fields, standardized donor fields, and field migrations. - name: Trips description: >- Mission-trip management: trips, participants, budgets, tasks, e-signatures, fundraising milestones, and background checks. - name: Communications description: >- Email templates, SMS, newsletters, donor email manager, and per-donor notes. - name: Payments description: >- Payment-gateway management (Stripe, PayPal, Flutterwave, QuickBooks). Excludes inbound webhooks — see the Webhooks tag. - name: Reports description: Dashboards, analytics, scheduled reports, and exports. - name: Admin description: >- Client-account administration: users, groups/permissions, settings, integrations, and account lifecycle. - name: Donor Portal description: >- Endpoints consumed by the donor-facing portal (donor login, dashboard, donation history, messages). - name: Recipient Portal description: Endpoints consumed by the recipient-facing portal. - name: Public description: >- Unauthenticated public endpoints: donor signup, public trip pages, peer-to-peer campaigns, public checkout. - name: Webhooks description: >- Inbound webhooks from third parties (Stripe, PayPal, Flutterwave, Checkr, DropboxSign). Annotated minimally for reference; payload shapes are owned by the upstream provider. - name: Client description: Client - name: Email Settings description: Email Settings - name: Admin Dashboard description: Admin Dashboard - name: Historical Archived Updates description: Historical Archived Updates - name: Team & access description: Team & access - name: Files description: Files - name: Wrapped description: Wrapped - name: Donor SignUp description: Donor SignUp - name: Frontend description: Frontend - name: User description: User paths: /frontend/add_entity/{client_id}/{program_id}/{session_id}: post: tags: - Public summary: Create a public recipient/entity description: >- Creates an entity from a public add-recipient form. The controller delegates to `EntityService::createEntity`, which scopes the program by client, validates `sp_num` according to program type, validates optional email format, enforces any unique public field configured on the HysForm, stores remaining request fields in entity `json_fields`, increments the program counter, logs frontend activity, and reloads the entity cache. The route is throttled by `frontend-add-entity` middleware. operationId: postPublicAddEntity parameters: - name: client_id in: path description: Client id that owns the target program and new entity. required: true schema: type: integer example: 207 - name: program_id in: path description: >- Program id whose HysForm determines the public entity fields and whose counter is incremented. required: true schema: type: integer example: 11 - name: session_id in: path description: >- Optional existing frontend session. When valid, successful creation binds the new recipient to this session for a subsequent public upload. required: true schema: type: string example: 7f2c8f8d64b8a1d4a9e2 requestBody: description: >- 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. required: true content: application/json: schema: properties: sp_num: description: >- Sponsorship number or goal. Validator rule is dynamic: `nullable|integer` for number programs, `nullable|numeric` for contribution/funding programs. type: string example: '1000' nullable: true sp_amount: description: Sponsorship amount stored on the entity after trimming. type: string example: '35.00' nullable: true email: description: 'Optional entity email. Validator rule: `nullable|email`.' type: string format: email example: recipient@example.org nullable: true tags: description: >- Optional tags; the service joins them with commas and synchronizes client tags; tag names cannot contain commas. type: array items: type: string example: - urgent - school nullable: true is_visible: description: >- Optional public visibility flag; defaults to visible when omitted. type: boolean example: true nullable: true type: object additionalProperties: true responses: '200': description: Entity created. content: application/json: schema: properties: status: type: string example: success message: type: string example: Entity added successfully entity_id: type: integer example: 4711 entity: $ref: '#/components/schemas/Entity' type: object '404': description: Program was not found for this client. content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' '422': description: Program-type, email, or unique-field validation failed. content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' '429': description: Public add-entity throttle limit exceeded. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: [] components: schemas: Entity: title: Entity description: >- 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. required: - id - client_id - program_id properties: id: description: Internal entity ID. type: integer format: int64 example: 4711 client_id: description: Owning Gratona client (multi-tenant scope). type: integer format: int64 example: 207 program_id: description: >- Program this entity belongs to. The program's `hysform_id` defines which custom fields appear in `json_fields`. type: integer format: int64 example: 11 status: description: >- Sponsorship status — typically `'0'` = unsponsored, `'1'` = sponsored. Stored as a string for historical reasons. type: string example: '0' nullable: true is_visible: description: Whether the entity is shown on public-facing sponsorship listings. type: boolean example: true is_featured: description: Whether the entity is highlighted on the public sponsorship page. type: boolean example: false json_fields: description: >- Arbitrary custom fields keyed by the program's HysForm. Common keys vary by client (e.g. `name`, `birthdate`, `country`, `bio`). Use the program's hysform definition to interpret them. type: object nullable: true additionalProperties: true batch_id: description: Set when the entity was created via CSV import. type: integer format: int64 example: null nullable: true created_at: type: string format: date-time example: '2025-09-01T14:00:00Z' updated_at: type: string format: date-time example: '2025-12-30T09:12:00Z' deleted_at: type: string format: date-time example: null nullable: true type: object NotFoundResponse: title: NotFoundResponse description: >- Returned with HTTP 404 when a resource lookup misses (typically because the id doesn't exist OR is scoped to a different `client_id`). Note: many endpoints intentionally collapse 'not found' and 'forbidden' into a single 404 to avoid leaking which records exist in another tenant. required: - message properties: message: description: >- Human-readable message. Often a more specific string like `Donor not found` or `Trip not found`. type: string example: Not Found status: type: string example: error type: object ValidationErrorResponse: title: ValidationErrorResponse description: >- Returned with HTTP 422 when `Validator::make($data, $rules)` fails. The `errors` map is keyed by the failing field name; each value is an array of human-readable error messages for that field. Most controllers also include a top-level `status: error`. required: - errors properties: errors: description: >- Map of field name to array of validator error messages. Example: `{email: [The email field is required.], amount: [The amount must be a number.]}`. type: object additionalProperties: type: array items: type: string status: description: Always the literal string `error`. type: string example: error message: description: >- Optional summary message — present on some endpoints, absent on others. type: string example: The given data was invalid. nullable: true type: object ErrorResponse: title: ErrorResponse description: >- Generic error envelope used by most controllers. Most error responses pair a human-readable `message` with `status: error`. Some endpoints additionally include `errors` (validator errors), `error` (legacy single-error string), `code`, or domain-specific context fields. required: - message properties: message: description: Human-readable error message. type: string example: Something went wrong. Please try again. status: description: >- Always the literal string `error` for failures. Some endpoints omit this field. type: string example: error error: description: Legacy single error code/string used by older endpoints. type: string example: invalid_request nullable: true code: description: >- Optional application-level error code (not all endpoints populate this). type: string example: DONOR_NOT_FOUND nullable: true type: object ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.