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

# Redeem an administrator activation link

> Consumes a one-time, purpose-bound invitation credential. Successful redemption proves mailbox ownership, activates the member, and returns the same authenticated administrator session payload used by passwordless sign-in.



## OpenAPI

````yaml post /user/email/verification
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:
  /user/email/verification:
    post:
      tags:
        - Auth
      summary: Redeem an administrator activation link
      description: >-
        Consumes a one-time, purpose-bound invitation credential. Successful
        redemption proves mailbox ownership, activates the member, and returns
        the same authenticated administrator session payload used by
        passwordless sign-in.
      operationId: 1d60f530b0b9afd4aba90aa1e86d11d5
      requestBody:
        description: Data required for user activation
        required: true
        content:
          application/json:
            schema:
              required:
                - id
                - activationCode
              properties:
                id:
                  type: integer
                activationCode:
                  description: >-
                    The signed admin:activate bearer credential from the
                    activation email.
                  type: string
              type: object
      responses:
        '200':
          description: Activation credential redeemed
          content:
            application/json:
              schema:
                properties:
                  status:
                    type: string
                    example: success
                  token:
                    description: Authenticated administrator Passport bearer token.
                    type: string
                  user:
                    $ref: '#/components/schemas/User'
                  permissions:
                    type: object
                    additionalProperties: true
                type: object
        '403':
          description: >-
            Missing, expired, wrong-purpose, wrong-user, or already-redeemed
            credential
          content:
            application/json:
              schema:
                properties:
                  message:
                    type: string
                    example: This activation link is invalid or expired.
                type: object
        '422':
          description: Validation failure
      security: []
components:
  schemas:
    User:
      title: User
      description: >-
        An admin user — staff member of a client organization. Authenticates via
        Laravel Passport (bearer JWT) for the admin web app, and may also issue
        API keys (via `ApiKey`) for server-to-server integrations. Permissions
        are stored as JSON keyed by feature; group membership (`group_id`)
        supplies a baseline permission set on top of the per-user override.
      required:
        - id
        - email
        - client_id
      properties:
        id:
          description: Internal user ID.
          type: integer
          format: int64
          example: 1024
        email:
          description: >-
            User email — also the login identifier. Unique across the whole
            users table.
          type: string
          format: email
          example: staff@gratona.com
        first_name:
          description: Given name.
          type: string
          example: Alex
          nullable: true
        last_name:
          description: Family name.
          type: string
          example: Morgan
          nullable: true
        phone:
          description: Optional phone number for SMS / call notifications.
          type: string
          example: '+15551234567'
          nullable: true
        client_id:
          description: >-
            Client (tenant) the user belongs to. Stored as string for historical
            reasons; numeric in practice.
          type: string
          example: '207'
        group_id:
          description: >-
            Permission group the user belongs to; supplies baseline permissions
            before the per-user override.
          type: integer
          format: int64
          example: 4
          nullable: true
        permissions:
          description: >-
            Per-user permission overrides as a JSON map keyed by permission
            slug. Values are typically the string `1` (granted) or absent.
            Merged with group permissions at request time. Example: `{group_all:
            1, donor-42: 1}`.
          type: object
          nullable: true
          additionalProperties: true
        onboarding_status:
          description: >-
            Onboarding-flow stage marker. `3` = onboarding complete; lower
            values indicate the user is still in setup.
          type: string
          example: '3'
          nullable: true
        activated:
          description: >-
            Whether the account is activated (email verified / activation code
            redeemed).
          type: boolean
          example: true
        access_disabled_at:
          description: >-
            Administrative disable timestamp. Authorized admin payloads expose
            it so clients can distinguish disabled access from a pending
            mailbox-proof invitation.
          type: string
          format: date-time
          example: null
          nullable: true
        is_platform_admin:
          description: >-
            Server-resolved platform authority. Clients must treat false or
            missing as no platform authority and must not infer this grant from
            persisted roles or legacy ids.
          type: boolean
          example: false
        activation_code:
          description: Pending activation token — null after activation.
          type: string
          example: null
          nullable: true
        activated_at:
          type: string
          format: date-time
          example: '2024-06-15T10:00:00Z'
          nullable: true
        last_login:
          type: string
          format: date-time
          example: '2026-04-29T14:01:00Z'
          nullable: true
        email_verified_at:
          type: string
          format: date-time
          example: '2024-06-15T10:00:00Z'
          nullable: true
        created_at:
          type: string
          format: date-time
          example: '2024-06-15T09:50:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-04-29T14:01:00Z'
      type: object

````

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