> ## 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 journey message template

> Creates an enabled source template in the organization library. Email requires a subject; SMS availability depends on installed messaging support. Embedded story reuse validates permission and review evidence. Requires journeys_manage or group_all.



## OpenAPI

````yaml post /admin/journeys/message-templates
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 commitment relationships, lifecycle transitions, and
      commitment-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: Events
    description: >-
      Event setup, invitations, registration, ticketing, attendance and event
      reporting.
  - name: Journeys
    description: >-
      Journey graphs, activation, enrollment, message templates and event
      follow-up automations.
  - name: Tasks
    description: Workspace tasks, assignments, saved task views and record collaboration.
  - name: Fundraising
    description: >-
      Fundraising portfolios, stewardship plans, giving anniversaries and
      personal donor follow-up.
  - name: Impact Stories
    description: Story intake, review, assets, consent and publication workflows.
  - name: Integrations
    description: Workspace integration connections, mappings, synchronization and recovery.
  - name: Email Calendar
    description: Connected email/calendar accounts and donor interactions.
  - name: Spaces
    description: Workspace Spaces and collaborative Pages.
  - name: Library
    description: Workspace documents, source connections, files and analysis.
  - name: Intelligence
    description: Donor intelligence and Tali workspace workflows.
  - name: Automation
    description: >-
      V3 automation primitive discovery, input validation, invocation and Zapier
      contracts.
  - name: Schema
    description: V3 model, enum, capability and scope discovery.
  - name: Zapier
    description: Zapier automation connections, polling feeds and actions.
  - name: Files
    description: Files
  - name: Client
    description: Client
  - name: Payment Gateways
    description: Payment Gateways
  - name: Email Settings
    description: Email Settings
  - name: Admin Dashboard
    description: Admin Dashboard
  - name: Recipients
    description: Recipients
  - name: Historical Archived Updates
    description: Historical Archived Updates
  - name: Team & access
    description: Team & access
  - name: Settings
    description: Settings
  - name: Notifications
    description: Notifications
  - name: Participation
    description: Participation
  - name: Users
    description: Users
  - name: Wrapped
    description: Wrapped
  - name: Donor SignUp
    description: Donor SignUp
  - name: Frontend
    description: Frontend
  - name: User
    description: User
  - name: Workspace
    description: Workspace
paths:
  /admin/journeys/message-templates:
    post:
      tags:
        - Journeys
      summary: Create a journey message template
      description: >-
        Creates an enabled source template in the organization library. Email
        requires a subject; SMS availability depends on installed messaging
        support. Embedded story reuse validates permission and review evidence.
        Requires journeys_manage or group_all.
      operationId: JourneyMessageTemplateController_store
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
                - channel
                - name
                - body
              properties:
                name:
                  description: Template label; nonblank after trimming.
                  type: string
                  maxLength: 120
                  example: Welcome message
                subject:
                  description: >-
                    Email subject; required and nonblank by the service for
                    email templates.
                  type: string
                  maxLength: 255
                  example: Welcome
                  nullable: true
                body:
                  description: >-
                    Nonblank email HTML or SMS message; embedded stories require
                    current publication permission and evidence.
                  type: string
                  example: Hello {{first_name}}
                impact_story_ids:
                  type: array
                  items:
                    description: Distinct approved story ID for SMS evidence.
                    type: integer
                    minimum: 1
                    example: 42
                  maxItems: 25
                design:
                  description: >-
                    Email designer document as JSON or a serialized string;
                    nullable.
                  nullable: true
                editor_mode:
                  description: Accepted editor mode hint; actual mode follows channel.
                  type: string
                  maxLength: 32
                  example: email
                  nullable: true
                entity_type:
                  description: >-
                    Journey subject type; sponsorship availability follows the
                    workspace lifecycle feature flag.
                  type: string
                  enum:
                    - donor
                    - trip_participant
                    - entity
                    - sponsorship
                    - null
                  example: donor
                  nullable: true
                channel:
                  description: Message channel.
                  type: string
                  enum:
                    - email
                    - sms
                  example: email
              type: object
      responses:
        '201':
          description: Create a journey message template completed.
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/JourneyApiMessageTemplate'
                type: object
        '401':
          description: Authentication is required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Insufficient permission or feature access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: An embedded story changed during evidence preparation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: >-
            Invalid content, unavailable SMS support or unapproved story
            evidence.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestRejection'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    JourneyApiMessageTemplate:
      properties:
        id:
          description: Template ID.
          type: integer
          example: 42
        value:
          description: Template selection value.
          type: integer
          example: 42
        label:
          description: Template label.
          type: string
          example: Welcome message
        channel:
          description: Message channel.
          type: string
          enum:
            - email
            - sms
          example: email
        scope_type:
          description: Library scope.
          type: string
          example: journeys_library
        set_id:
          description: Owning template-set ID.
          type: integer
          example: 42
          nullable: true
        set_name:
          description: Owning template-set name.
          type: string
          example: Example
          nullable: true
        configured:
          description: Whether message content is present.
          type: boolean
          example: false
        enabled:
          description: Whether the source template is enabled.
          type: boolean
          example: false
        last_updated_at:
          description: Source update time.
          type: string
          format: date-time
          example: '2026-10-20T12:00:00Z'
          nullable: true
        template_family:
          description: Template family.
          type: string
          example: journey_library
        trigger:
          description: Stable library trigger key.
          type: string
          example: journey_template:welcome
        subject:
          description: Email subject; email templates only.
          type: string
          example: Welcome
        body:
          description: Message body.
          type: string
          example: Hello {{first_name}}
        body_preview:
          description: Plain-text preview, limited to 220 characters.
          type: string
          example: Hello Jane
        editor_mode:
          description: Channel editor mode.
          type: string
          example: email
        has_design:
          description: Email design is available; email only.
          type: boolean
          example: false
        source_scope_label:
          description: Source label.
          type: string
          example: Journeys library
        shared_live_link_warning:
          description: Editing impact notice.
          type: string
          example: >-
            Editing this source updates every journey step that is still
            live-linked to it.
        impact_story_ids:
          type: array
          items:
            description: Retained SMS story evidence ID.
            type: integer
            example: 42
        design:
          description: >-
            Decoded email designer document or raw saved string; email detail
            only.
          nullable: true
        merge_schema:
          type: array
          items:
            description: Merge-schema field group from the selected journey entity context.
            type: object
            additionalProperties: true
        merge_tags:
          description: Unlayer merge tags keyed by group.
          type: object
          additionalProperties: true
        preview_context:
          description: Resolved sample context and merge_data.
          type: object
          additionalProperties: true
        preview_subject:
          description: Rendered email subject.
          type: string
          example: Welcome Jane
        preview_html:
          description: Rendered email HTML.
          type: string
          example: <p>Hello Jane</p>
        from_label:
          description: Organization or sender label.
          type: string
          example: Example Foundation
      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
    RequestRejection:
      description: >-
        Request or workflow rejection. Framework field-validation failures
        contain errors; semantic rejections may contain message without errors;
        legacy/provider failures may use error and error_code. The operation
        description identifies the rejected condition. Domain responses may add
        current revision, limits or other conflict context.
      anyOf:
        - $ref: '#/components/schemas/ValidationErrorResponse'
        - $ref: '#/components/schemas/ErrorResponse'
        - required:
            - error
          properties:
            error:
              description: Legacy or provider-facing error message.
              type: string
              example: The request could not be completed.
            error_code:
              description: Stable domain error code, when provided.
              type: string
              example: WORKFLOW_UNAVAILABLE
          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
  securitySchemes:
    bearerAuth:
      type: http
      description: Passport bearer token authentication for legacy admin sessions.
      scheme: bearer
      bearerFormat: JWT
    apiKeyAuth:
      type: apiKey
      description: Gratona API key sent with the compatibility header X-HYS-API-Key.
      name: X-HYS-API-Key
      in: header

````

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