academyFIVE API Beta icon

academyFIVE API Beta

Interact with academyFIVE API

Actions482

Gkv-pending-messages → Create a new GKV pending message

AI-generated

Summary

Creates a GKV pending message by sending the configured data object to the academyFIVE API. Supply the required message type and attributes.receivedDate; other listed attributes are optional.

Inputs

  • data (required) — Message data object containing required type and attributes.
  • data.type (required) — Type of pending message.
  • data.attributes (required) — Message attributes. receivedDate is required; optional fields include handled (defaults to false), handledDate, firstname, lastname, dateOfBirth, healthInsuranceNumber, instituteIdentification, messageType, message, responseId, selectedProfileId, assignedProfileId, and messageContent.

Output shape

A list of JSON items returned by the API, paired with their corresponding input items.

With Continue On Fail enabled, a failed request produces an item with an error field. The API response body determines the returned JSON shape.

Examples

Example 1: Create a pending message with required fields

Set data.type and data.attributes.receivedDate; optionally provide other listed attributes.

Links

Discussion