Add a new BaseEventInvitation

POST /api/event/base_event_invitation

Query parameters

  • iw-build-id string

    build id of the client

  • iw-package-id string

    package id of the client

application/json

Body Required

  • data object
    Hide data attributes Show data attributes object
    • id integer
    • read boolean
    • message string
    • reply_message string
    • company object
    • person object
    • base_event object

Responses

  • 200 application/json

    Add a new BaseEventInvitation

    Hide response attributes Show response attributes object
    • company object
      Hide company attributes Show company attributes object
      • id integer
      • company_name string
      • main_phone string
      • main_fax string
      • main_email string
      • website string
    • person object
      Hide person attributes Show person attributes object
      • id integer
      • first_name string
      • last_name string
      • avatar_token string
      • order integer
    • baseEvent object
      Hide baseEvent attributes Show baseEvent attributes object
      • id integer
      • event_type string
      • event_people_limit integer
      • event_people_min_limit integer
      • hide_event_people_limit boolean
      • has_wait_list boolean
      • can_sign_up_for_main_event boolean
      • only_sign_up_for_main_event boolean
      • start_time string(date-time)
      • end_time string(date-time)
      • require_address boolean
      • require_contact boolean
      • require_billing boolean
      • allow_direct_billing boolean
      • require_age boolean
      • require_grade_level boolean
      • require_free_note_field_ids string
      • generate_new_bookings boolean
      • generate_new_bookings_v2 boolean
      • generate_ignore_sys_calendar boolean
      • generate_hour_start string(date-time)
      • generate_hour_end string(date-time)
      • generate_day_of_week integer
      • bitmask_days_of_week integer
      • bitmask_hours_start integer
      • summarized_date_times string
      • customer_detail_cta string
      • customer_badge string
      • main_phone string
      • main_fax string
      • main_email string
      • website string
      • name string
      • image_url string
    • id integer
    • read boolean
    • token string
    • first_name string
    • last_name string
    • gender string
    • birthday string(date-time)
    • message string
    • reply_message string
    • main_phone string
    • main_fax string
    • main_email string
    • website string
    • order integer
POST /api/event/base_event_invitation
curl \
 --request POST 'https://replace-with-own-host.iw-erp.de/api/event/base_event_invitation' \
 --header "x-session-token: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"data":{"id":42,"read":true,"message":"string","reply_message":"string","company":{},"person":{},"base_event":{}}}'
Request examples
{
  "data": {
    "id": 42,
    "read": true,
    "message": "string",
    "reply_message": "string",
    "company": {},
    "person": {},
    "base_event": {}
  }
}
Response examples (200)
{
  "company": {
    "id": 42,
    "company_name": "string",
    "main_phone": "string",
    "main_fax": "string",
    "main_email": "string",
    "website": "string"
  },
  "person": {
    "id": 42,
    "first_name": "string",
    "last_name": "string",
    "avatar_token": "string",
    "order": 42
  },
  "baseEvent": {
    "id": 42,
    "event_type": "string",
    "event_people_limit": 42,
    "event_people_min_limit": 42,
    "hide_event_people_limit": true,
    "has_wait_list": true,
    "can_sign_up_for_main_event": true,
    "only_sign_up_for_main_event": true,
    "start_time": "2025-05-04T09:42:00Z",
    "end_time": "2025-05-04T09:42:00Z",
    "require_address": true,
    "require_contact": true,
    "require_billing": true,
    "allow_direct_billing": true,
    "require_age": true,
    "require_grade_level": true,
    "require_free_note_field_ids": "string",
    "generate_new_bookings": true,
    "generate_new_bookings_v2": true,
    "generate_ignore_sys_calendar": true,
    "generate_hour_start": "2025-05-04T09:42:00Z",
    "generate_hour_end": "2025-05-04T09:42:00Z",
    "generate_day_of_week": 42,
    "bitmask_days_of_week": 42,
    "bitmask_hours_start": 42,
    "summarized_date_times": "string",
    "customer_detail_cta": "string",
    "customer_badge": "string",
    "main_phone": "string",
    "main_fax": "string",
    "main_email": "string",
    "website": "string",
    "name": "string",
    "image_url": "string"
  },
  "id": 42,
  "read": true,
  "token": "string",
  "first_name": "string",
  "last_name": "string",
  "gender": "string",
  "birthday": "2025-05-04T09:42:00Z",
  "message": "string",
  "reply_message": "string",
  "main_phone": "string",
  "main_fax": "string",
  "main_email": "string",
  "website": "string",
  "order": 42
}