> ## 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 an event communication > Saves a communication template with normalized shortcodes, notification preferences and Message Manager approval metadata. Scheduled messages are later handled by the queue; only email is automatically delivered. Communications hold blocks scheduling. Relative schedules require a dated event and resolve in its timezone. The structured schedule must match legacy send_at when both are supplied. Requires events_manage. ## OpenAPI ````yaml post /admin/events/{eventId}/communications 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}/communications: post: tags: - Events summary: Create an event communication description: >- Saves a communication template with normalized shortcodes, notification preferences and Message Manager approval metadata. Scheduled messages are later handled by the queue; only email is automatically delivered. Communications hold blocks scheduling. Relative schedules require a dated event and resolve in its timezone. The structured schedule must match legacy send_at when both are supplied. Requires events_manage. operationId: EventController_storeCommunication 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: - type properties: type: description: Type. type: string maxLength: 80 example: Example trigger: description: Trigger. type: string maxLength: 80 example: Example nullable: true channel: description: Channel. type: string format: email enum: - email - sms - task example: email status: description: Status. type: string enum: - draft - scheduled - sent - paused example: draft segment: description: >- Purchaser audience; registered_attendees, attended_and_gave, attended_no_gift, no_show, sponsor_package_buyers or potential_child_sponsors select completed paid/free/offline order subsets. Unknown values use all completed purchasers. type: string maxLength: 120 example: Example nullable: true subject: description: Subject. type: string maxLength: 255 example: Example nullable: true body: description: Body. type: string example: Example nullable: true send_at: description: >- Send at. Date without offset is interpreted in the event timezone. type: string format: date-time example: '2026-12-20T18:00:00Z' nullable: true sent_at: description: >- Sent at. Date without offset is interpreted in the event timezone. type: string format: date-time example: '2026-12-20T18:00:00Z' nullable: true metadata: description: Metadata. type: object nullable: true additionalProperties: true schedule: oneOf: - $ref: '#/components/schemas/EventApiCommunicationSchedule' - type: string enum: - null nullable: true type: object responses: '201': description: Create an event communication completed. content: application/json: schema: properties: data: $ref: '#/components/schemas/EventApiCommunication' 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' '422': description: >- Invalid fields, held communication, schedule intent, inconsistent time or past relative schedule. content: application/json: schema: $ref: '#/components/schemas/RequestRejection' '500': description: >- The relative event anchor cannot be resolved or its supplied ID does not match this event. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - bearerAuth: [] - apiKeyAuth: [] components: schemas: EventApiCommunicationSchedule: description: >- Closed instant/relative intent; a supplied legacy send_at must match the resolved instant. oneOf: - required: - kind - localDatetime - timezone - offsetMinutes - utcAt - source properties: kind: description: Absolute-instant schedule. type: string enum: - instant example: instant localDatetime: description: Confirmed local wall time, exactly YYYY-MM-DDTHH:mm:ss. type: string example: '2026-12-19T18:00:00' timezone: description: Valid IANA timezone. type: string example: Africa/Kampala offsetMinutes: description: Offset east of UTC at the confirmed instant. type: integer example: 180 utcAt: description: Matching UTC instant ending in Z; must be in the future. type: string format: date-time example: '2026-12-19T15:00:00Z' source: description: Schedule source. type: string enum: - calendar - natural_language - preset - recommendation - legacy example: calendar recommendationId: description: Required only when source=recommendation. type: string example: recommendation-42 nullable: true type: object additionalProperties: false - required: - kind - anchor - direction - amount - unit - source properties: kind: description: Relative event schedule. type: string enum: - relative example: relative anchor: required: - type properties: type: description: Event date used as anchor. type: string enum: - event_start - event_end example: event_start id: description: Optional anchor ID; if supplied it must match this event. type: integer example: 42 type: object additionalProperties: false direction: description: Offset direction. type: string enum: - before - after example: before amount: description: Offset amount. type: integer maximum: 365 minimum: 1 example: 1 unit: description: Offset unit. type: string enum: - hours - days - weeks example: hours localTime: description: Optional local time in HH:mm format. type: string pattern: ^(?:[01][0-9]|2[0-3]):[0-5][0-9]$ example: '09:00' nullable: true timezone: description: >- Optional IANA timezone; the event timezone determines resolution. type: string example: Africa/Kampala nullable: true resolvedPreview: description: >- Optional submitted preview; it is not trusted for schedule resolution. source: description: Relative schedule source. type: string enum: - calendar - preset example: calendar type: object additionalProperties: false EventApiCommunication: properties: id: description: Id. type: integer example: 1 client_id: description: Client id. type: integer example: 1 nullable: false event_id: description: Event id. type: integer example: 1 nullable: false type: description: Type. type: string example: Example nullable: false trigger: description: Trigger. type: string example: Example nullable: true channel: description: Channel. type: string example: Example nullable: false status: description: Status. type: string enum: - draft - scheduled - sent - paused example: draft nullable: false segment: description: Segment. type: string example: Example nullable: true subject: description: Subject. type: string example: Example nullable: true body: description: Body. type: string example: Example nullable: true send_at: description: Send at. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true schedule_mode: description: Schedule mode. type: string example: Example schedule_config: description: Schedule config. type: object additionalProperties: true schedule_claim_id: description: Schedule claim id. type: integer example: 1 claimed_at: description: Claimed at. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true sent_at: description: Sent at. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true metadata: description: Metadata. type: object nullable: true additionalProperties: true created_at: description: Created at. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true updated_at: description: Updated at. type: string format: date-time example: '2026-10-20T12:00:00Z' nullable: true deleted_at: description: Deleted at. type: string format: date-time example: '2026-10-20T12:00:00Z' 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 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 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.