> ## 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. # Save the event invitation plan > Replaces the definition and increments revision/lock. Existing applied task snapshots remain unchanged. Supply the current lock, or zero for first save. One to ten steps must be enabled; offsets are 0–365 days, titles allow only donor_name/event_name tokens, specific assignees must be active and see this event. Unknown or duplicate step keys become new generated keys. Requires event setup management; archived event invitation history is read-only (409). Also requires task management permission. ## OpenAPI ````yaml put /admin/events/{eventId}/invitation-plan 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/events/{eventId}/invitation-plan: put: tags: - Events summary: Save the event invitation plan description: >- Replaces the definition and increments revision/lock. Existing applied task snapshots remain unchanged. Supply the current lock, or zero for first save. One to ten steps must be enabled; offsets are 0–365 days, titles allow only donor_name/event_name tokens, specific assignees must be active and see this event. Unknown or duplicate step keys become new generated keys. Requires event setup management; archived event invitation history is read-only (409). Also requires task management permission. operationId: EventInvitationController_savePlan parameters: - name: eventId in: path description: Record ID in the authenticated organization. required: true schema: type: integer example: 42 example: 42 requestBody: required: true content: application/json: schema: required: - name - expected_lock_version - steps properties: name: description: Nonblank plan name. type: string maxLength: 120 example: Personal invitation expected_lock_version: description: Current lock; zero if no plan is saved. type: integer minimum: 0 example: 0 steps: type: array items: required: - label - task_title_template - days_before_event properties: step_key: description: >- Stable existing step key; unknown/duplicate keys are replaced with generated custom keys on save. type: string maxLength: 80 example: personal_call position: description: One-based plan position. type: integer example: 42 label: description: Nonblank step label. type: string maxLength: 120 example: Personal call task_title_template: description: >- Nonblank task title; only {donor_name} and {event_name} tokens are allowed. type: string maxLength: 255 example: Call {donor_name} about {event_name} invitation_method: description: Invitation contact method. type: string enum: - phone_call - text_message - email - handwritten_note - printed_mail - in_person - voicemail - other - null example: phone_call nullable: true days_before_event: description: >- Suggested date offset before the event start in event timezone. type: integer maximum: 365 minimum: 0 example: 28 assignee_strategy: description: Task assignee strategy. type: string enum: - invitee_owner - specific_user - unassigned example: invitee_owner assignee_user_id: description: >- Required active event-accessible user for specific_user. type: integer example: 42 nullable: true is_enabled: description: Whether included in plan applications; defaults true. type: boolean example: true type: object minItems: 1 type: object responses: '200': description: Save the event invitation plan completed. content: application/json: schema: properties: data: $ref: '#/components/schemas/EventApiInvitationPlan' 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' '404': description: Resource not found in the organization or feature unavailable. content: application/json: schema: $ref: '#/components/schemas/NotFoundResponse' '409': description: Version, idempotency, preview or archived-event conflict. content: application/json: schema: properties: message: description: Error explanation. type: string example: Version, idempotency, preview or archived-event conflict. error_code: description: Event domain code. type: string example: event_invitee_conflict details: properties: current_version: description: Current invitee version when provided. type: integer example: 42 current_lock_version: description: Current plan lock when provided. type: integer example: 42 current_revision: description: Current plan revision when provided. type: integer example: 42 current_definition_hash: description: Current definition hash when provided. type: string example: >- aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa type: object additionalProperties: true type: object '422': description: Invalid request, owner, plan step/date or selection. content: application/json: schema: $ref: '#/components/schemas/RequestRejection' security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: EventApiInvitationPlan: properties: materialized: description: False for the unpersisted default; save before applying. type: boolean example: false id: description: Saved plan ID; null until saved. type: integer example: 42 nullable: true name: description: Plan name. type: string example: Personal invitation revision: description: Plan definition revision; starts at zero before save. type: integer minimum: 0 example: 1 lock_version: description: Optimistic lock; use zero for first save. type: integer minimum: 0 example: 1 source_preset_key: description: Starter preset key. type: string example: personal_invitation_v1 source_preset_version: description: Starter preset version. type: integer example: 42 definition_hash: description: SHA-256 of the current definition. type: string maxLength: 64 minLength: 64 example: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa steps: type: array items: $ref: '#/components/schemas/EventApiInvitationPlanStep' 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 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 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 EventApiInvitationPlanStep: properties: id: description: Persisted step ID; omitted in preset. type: integer example: 42 step_key: description: >- Stable existing step key; unknown/duplicate keys are replaced with generated custom keys on save. type: string maxLength: 80 example: personal_call position: description: One-based plan position. type: integer example: 42 label: description: Nonblank step label. type: string maxLength: 120 example: Personal call task_title_template: description: >- Nonblank task title; only {donor_name} and {event_name} tokens are allowed. type: string maxLength: 255 example: Call {donor_name} about {event_name} invitation_method: description: Invitation contact method. type: string enum: - phone_call - text_message - email - handwritten_note - printed_mail - in_person - voicemail - other - null example: phone_call nullable: true days_before_event: description: Suggested date offset before the event start in event timezone. type: integer maximum: 365 minimum: 0 example: 28 assignee_strategy: description: Task assignee strategy. type: string enum: - invitee_owner - specific_user - unassigned example: invitee_owner assignee_user_id: description: Required active event-accessible user for specific_user. type: integer example: 42 nullable: true is_enabled: description: Whether included in plan applications; defaults true. type: boolean example: true 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.