> ## 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.

# Start Email Sign-In

> Starts the email-based sign-in flow with a six-digit numeric code and magic link. A new issue invalidates the previous code for the tenant, program, donor, and email scope.



## OpenAPI

````yaml post /frontend/passwordless_login/{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/passwordless_login/{client_id}/{program_id}/{session_id}:
    post:
      tags:
        - Donor Portal
      summary: Start Email Sign-In
      description: >-
        Starts the email-based sign-in flow with a six-digit numeric code and
        magic link. A new issue invalidates the previous code for the tenant,
        program, donor, and email scope.
      operationId: postPasswordlessLogin
      parameters:
        - name: client_id
          in: path
          description: Client ID for the email sign-in flow
          required: true
          schema:
            type: integer
        - name: program_id
          in: path
          description: Program ID for the email sign-in flow
          required: true
          schema:
            type: integer
        - name: session_id
          in: path
          description: Session ID for the email sign-in flow (optional)
          required: true
          schema:
            type: string
      requestBody:
        description: Email address for email sign-in
        required: true
        content:
          application/json:
            schema:
              required:
                - email
              properties:
                email:
                  type: string
                  format: email
                donor_id:
                  description: Optional donor ID when a donor has already been selected
                  type: integer
                  nullable: true
                passwordless_mode:
                  description: Requested email sign-in delivery mode
                  type: string
                  enum:
                    - magic_link
                    - verification_code
                  nullable: true
              type: object
      responses:
        '200':
          description: >-
            Sign-in instructions sent successfully or a donor selection is
            required
          content:
            application/json:
              schema:
                properties:
                  status:
                    description: >-
                      `success` when the email sign-in flow continues, or
                      `selection_required` when multiple donor accounts match
                      the email.
                    type: string
                    example: success
                  message:
                    type: string
                  donor:
                    description: >-
                      Returned for auto-resolved single-donor email sign-ins so
                      the frontend can offer verification-code fallback.
                    properties:
                      id:
                        type: integer
                      display_name:
                        type: string
                      username:
                        type: string
                        nullable: true
                      email:
                        type: string
                        format: email
                    type: object
                    nullable: true
                  donors:
                    description: >-
                      Returned when a donor selection is required before sending
                      the sign-in email.
                    type: array
                    items:
                      properties:
                        id:
                          type: integer
                        display_name:
                          type: string
                        username:
                          type: string
                          nullable: true
                        email:
                          type: string
                          format: email
                      type: object
                type: object
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                type: object
        '429':
          description: The tenant/endpoint passwordless budget was exceeded.
          content:
            application/json:
              schema:
                properties:
                  status:
                    type: string
                    example: error
                  message:
                    type: string
                    example: Too many sign-in attempts. Please wait and try again.
                type: object
      security: []

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.