Allianz Engagement Survey · JSON Structure

Engagement Survey Add Participants Request Structure

Request body to add participants to a survey

Type: object Properties: 2 Required: 1
AnalyticsEnterpriseHuman ResourcesInsuranceSurveysEmployee Experience

AddParticipantsRequest is a JSON Structure definition published by Allianz Engagement Survey, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

employee_ids send_invitation

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "type": "object",
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/allianz-engagement-survey/refs/heads/main/json-structure/engagement-survey-add-participants-request-structure.json",
  "description": "Request body to add participants to a survey",
  "properties": {
    "employee_ids": {
      "type": "array",
      "description": "List of employee IDs to add as participants",
      "items": {
        "type": "string"
      },
      "example": [
        "emp-123456",
        "emp-123457"
      ]
    },
    "send_invitation": {
      "type": "boolean",
      "description": "Whether to send invitation emails immediately",
      "example": true
    }
  },
  "required": [
    "employee_ids"
  ],
  "name": "AddParticipantsRequest"
}