Zum Inhalt springen
Developer

ChatroomParticipant

Chat und Benachrichtigungen6 EndpunkteChat / ChatroomParticipant

Liefert eine Liste aller ChatroomParticipants-Objekte.

GET/api/chat/chatroom_participant

Query-Parameter

chatroomstring_LIST
personstring_LIST
companystring_LIST
eventSignUpstring_LIST
deletedbooleanDiese Eigenschaft markiert eine Entität als gelöscht / archiviert | Benötigtes Zugriffsrecht: SCOPE_LIST
participantTypestring_LIST
chatbotProfilestringDas Profil, aus dem dieser Bot-Teilnehmer seine Vorgaben zieht. Nur bei participantType internal_ai_bot gesetzt. | _LIST
searchStringstringText, nach dem in der Liste gesucht wird
orderFieldNamestringName des Bestellfelds
orderFieldSortstringSortiermodusErlaubt: DESCASC
pageintegerSeite der Liste
pageSizeintegerAnzahl der Einträge je Seite
withMaxPageNumberstringgibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert eine Liste aller ChatroomParticipants-Objekte.array<ChatroomParticipant2>

Felder anzeigen (24)
  • idinteger

    Primärschlüssel des Teilnehmers. Interne ID.

  • participant_typestring

    Art des Teilnehmers.

  • first_namestring

    Vorname des Teilnehmers.

  • last_namestring

    Nachname des Teilnehmers.

  • nicknamestring

    Spitzname der Teilnehmenden.

  • preferred_color_hexstring

    Bevorzugte Farbe des Teilnehmers als Hexwert.

  • avatar_tokenstring

    Token des Avatarbildes.

  • last_read_atstring (date-time)

    Zeitstempel des letzten Lesens des Chatraums durch diesen Teilnehmer

  • message_count_readinteger

    Anzahl der von der teilnehmenden Person gelesenen Nachrichten.

  • room_adminboolean

    Kennzeichen, ob dieser Teilnehmer Nachrichten im Chatraum löschen, den Chatraum umbenennen sowie Teilnehmer hinzufügen oder entfernen kann

  • can_writeboolean

    Kennzeichen, ob dieser Teilnehmer Nachrichten schreiben kann

  • is_mutedboolean

    Kennzeichen, ob dieser Teilnehmer Benachrichtigungen erhalten möchte

  • messenger_channelstring

    sms | whatsapp – gesetzt für einen externen Teilnehmer, der den Support per SMS oder WhatsApp kontaktiert; Antworten im Raum gehen über diesen Kanal zurück (MessengerSupportChatHelper).

  • messenger_phone_numberstring

    Mobilnummer des Messenger-Teilnehmers, E.164-Ziffern ohne +.

  • messenger_verified_atstring (date-time)

    Zeitpunkt, zu dem der Messenger verifiziert wurde.

  • left_atstring (date-time)

    Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange dies gesetzt ist, nimmt der Veranstaltungsabgleich sie nicht wieder auf.

  • left_reasonstring

    self | room_admin, siehe LEFT_REASON_*

  • notify_levelstring

    Wann diese Person eine Push-Benachrichtigung erhält: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer bedeutet: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.

  • muted_untilstring (date-time)

    Bis wann der Raum ganz stumm ist („für 8 Stunden aus“), danach gilt wieder notify_level.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • namestring

    Name der Einheit.

  • image_urlstring

    URL des Bildes des Datensatzes.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/chat/chatroom_participant \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "participant_type": "string",
    "nickname": "string",
    "preferred_color_hex": "string",
    "avatar_token": "string",
    "last_read_at": "2026-10-15T09:30:00+02:00"
  }
]

ChatroomParticipant neu anlegen

POST/api/chat/chatroom_participant

Request-Body application/json

  • dataChatroomParticipant3
    Felder anzeigen (31)
    • idinteger

      Primärschlüssel des Teilnehmers. Interne ID.

    • participant_typestring

      Art des Teilnehmers.

    • chatroomChatroom10

      Chatraum, zu dem der Teilnehmer gehört.

    • public_sessionPublicSession4

      Öffentliche Sitzung des Teilnehmers.

    • first_namestring

      Vorname des Teilnehmers.

    • last_namestring

      Nachname des Teilnehmers.

    • nicknamestring

      Spitzname der Teilnehmenden.

    • preferred_color_hexstring

      Bevorzugte Farbe des Teilnehmers als Hexwert.

    • avatar_tokenstring

      Token des Avatarbildes.

    • last_read_atstring (date-time)

      Zeitstempel des letzten Lesens des Chatraums durch diesen Teilnehmer

    • message_count_readinteger

      Anzahl der von der teilnehmenden Person gelesenen Nachrichten.

    • room_adminboolean

      Kennzeichen, ob dieser Teilnehmer Nachrichten im Chatraum löschen, den Chatraum umbenennen sowie Teilnehmer hinzufügen oder entfernen kann

    • can_writeboolean

      Kennzeichen, ob dieser Teilnehmer Nachrichten schreiben kann

    • is_mutedboolean

      Kennzeichen, ob dieser Teilnehmer Benachrichtigungen erhalten möchte

    • auto_createdboolean

      Kennzeichen, ob dieser Teilnehmer automatisch angelegt wurde, weil er einem Unternehmen oder einer Veranstaltung angehört

    • reply_modestring

      Überschreibung zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.

    • ai_auto_close_secret_wordstring

      Ein Wort als letzter Teil einer KI-Antwort, das den Chatraum schließt. Wird für KI-Bots verwendet.

    • ai_promptstring

      Der Systemprompt für den KI-Bot. Wird für KI-Bots verwendet.

    • ai_number_of_context_messagesinteger

      Die Anzahl der Nachrichten, die dem Kontext des KI-Bots hinzugefügt werden. Wird für KI-Bots verwendet.

    • messenger_channelstring

      sms | whatsapp – gesetzt für einen externen Teilnehmer, der den Support per SMS oder WhatsApp kontaktiert; Antworten im Raum gehen über diesen Kanal zurück (MessengerSupportChatHelper).

    • messenger_phone_numberstring

      Mobilnummer des Messenger-Teilnehmers, E.164-Ziffern ohne +.

    • messenger_verified_atstring (date-time)

      Zeitpunkt, zu dem der Messenger verifiziert wurde.

    • left_atstring (date-time)

      Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange dies gesetzt ist, nimmt der Veranstaltungsabgleich sie nicht wieder auf.

    • left_reasonstring

      self | room_admin, siehe LEFT_REASON_*

    • notify_levelstring

      Wann diese Person eine Push-Benachrichtigung erhält: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer bedeutet: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.

    • muted_untilstring (date-time)

      Bis wann der Raum ganz stumm ist („für 8 Stunden aus“), danach gilt wieder notify_level.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • namestring

      Name der Einheit.

    • image_urlstring

      URL des Bildes des Datensatzes.

Antworten

200ChatroomParticipant neu anlegenChatroomParticipant3

Felder anzeigen (31)
  • idinteger

    Primärschlüssel des Teilnehmers. Interne ID.

  • participant_typestring

    Art des Teilnehmers.

  • chatroomChatroom10

    Chatraum, zu dem der Teilnehmer gehört.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Chatraums. Interne ID.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • namestring

      Name der Einheit.

    • image_urlstring

      URL des Bildes des Datensatzes.

  • public_sessionPublicSession4

    Öffentliche Sitzung des Teilnehmers.

    Felder anzeigen (4)
    • idinteger

      Primärschlüssel der öffentlichen Sitzung. Interne ID.

    • tokenstring

      Token, das die öffentliche Sitzung identifiziert.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • first_namestring

    Vorname des Teilnehmers.

  • last_namestring

    Nachname des Teilnehmers.

  • nicknamestring

    Spitzname der Teilnehmenden.

  • preferred_color_hexstring

    Bevorzugte Farbe des Teilnehmers als Hexwert.

  • avatar_tokenstring

    Token des Avatarbildes.

  • last_read_atstring (date-time)

    Zeitstempel des letzten Lesens des Chatraums durch diesen Teilnehmer

  • message_count_readinteger

    Anzahl der von der teilnehmenden Person gelesenen Nachrichten.

  • room_adminboolean

    Kennzeichen, ob dieser Teilnehmer Nachrichten im Chatraum löschen, den Chatraum umbenennen sowie Teilnehmer hinzufügen oder entfernen kann

  • can_writeboolean

    Kennzeichen, ob dieser Teilnehmer Nachrichten schreiben kann

  • is_mutedboolean

    Kennzeichen, ob dieser Teilnehmer Benachrichtigungen erhalten möchte

  • auto_createdboolean

    Kennzeichen, ob dieser Teilnehmer automatisch angelegt wurde, weil er einem Unternehmen oder einer Veranstaltung angehört

  • reply_modestring

    Überschreibung zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.

  • ai_auto_close_secret_wordstring

    Ein Wort als letzter Teil einer KI-Antwort, das den Chatraum schließt. Wird für KI-Bots verwendet.

  • ai_promptstring

    Der Systemprompt für den KI-Bot. Wird für KI-Bots verwendet.

  • ai_number_of_context_messagesinteger

    Die Anzahl der Nachrichten, die dem Kontext des KI-Bots hinzugefügt werden. Wird für KI-Bots verwendet.

  • messenger_channelstring

    sms | whatsapp – gesetzt für einen externen Teilnehmer, der den Support per SMS oder WhatsApp kontaktiert; Antworten im Raum gehen über diesen Kanal zurück (MessengerSupportChatHelper).

  • messenger_phone_numberstring

    Mobilnummer des Messenger-Teilnehmers, E.164-Ziffern ohne +.

  • messenger_verified_atstring (date-time)

    Zeitpunkt, zu dem der Messenger verifiziert wurde.

  • left_atstring (date-time)

    Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange dies gesetzt ist, nimmt der Veranstaltungsabgleich sie nicht wieder auf.

  • left_reasonstring

    self | room_admin, siehe LEFT_REASON_*

  • notify_levelstring

    Wann diese Person eine Push-Benachrichtigung erhält: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer bedeutet: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.

  • muted_untilstring (date-time)

    Bis wann der Raum ganz stumm ist („für 8 Stunden aus“), danach gilt wieder notify_level.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • namestring

    Name der Einheit.

  • image_urlstring

    URL des Bildes des Datensatzes.

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/chat/chatroom_participant \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "participant_type": "string"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "participant_type": "string",
  "chatroom": {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00",
    "deleted": true
  },
  "public_session": {
    "id": 42,
    "token": "string",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  },
  "nickname": "string",
  "preferred_color_hex": "string"
}

Liefert einen einzelnen ChatroomParticipant-Eintrag.

GET/api/chat/chatroom_participant/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Gibt ein einzelnes ChatroomParticipant-Objekt zurück.ChatroomParticipant3

Felder anzeigen (31)
  • idinteger

    Primärschlüssel des Teilnehmers. Interne ID.

  • participant_typestring

    Art des Teilnehmers.

  • chatroomChatroom10

    Chatraum, zu dem der Teilnehmer gehört.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Chatraums. Interne ID.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • namestring

      Name der Einheit.

    • image_urlstring

      URL des Bildes des Datensatzes.

  • public_sessionPublicSession4

    Öffentliche Sitzung des Teilnehmers.

    Felder anzeigen (4)
    • idinteger

      Primärschlüssel der öffentlichen Sitzung. Interne ID.

    • tokenstring

      Token, das die öffentliche Sitzung identifiziert.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • first_namestring

    Vorname des Teilnehmers.

  • last_namestring

    Nachname des Teilnehmers.

  • nicknamestring

    Spitzname der Teilnehmenden.

  • preferred_color_hexstring

    Bevorzugte Farbe des Teilnehmers als Hexwert.

  • avatar_tokenstring

    Token des Avatarbildes.

  • last_read_atstring (date-time)

    Zeitstempel des letzten Lesens des Chatraums durch diesen Teilnehmer

  • message_count_readinteger

    Anzahl der von der teilnehmenden Person gelesenen Nachrichten.

  • room_adminboolean

    Kennzeichen, ob dieser Teilnehmer Nachrichten im Chatraum löschen, den Chatraum umbenennen sowie Teilnehmer hinzufügen oder entfernen kann

  • can_writeboolean

    Kennzeichen, ob dieser Teilnehmer Nachrichten schreiben kann

  • is_mutedboolean

    Kennzeichen, ob dieser Teilnehmer Benachrichtigungen erhalten möchte

  • auto_createdboolean

    Kennzeichen, ob dieser Teilnehmer automatisch angelegt wurde, weil er einem Unternehmen oder einer Veranstaltung angehört

  • reply_modestring

    Überschreibung zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.

  • ai_auto_close_secret_wordstring

    Ein Wort als letzter Teil einer KI-Antwort, das den Chatraum schließt. Wird für KI-Bots verwendet.

  • ai_promptstring

    Der Systemprompt für den KI-Bot. Wird für KI-Bots verwendet.

  • ai_number_of_context_messagesinteger

    Die Anzahl der Nachrichten, die dem Kontext des KI-Bots hinzugefügt werden. Wird für KI-Bots verwendet.

  • messenger_channelstring

    sms | whatsapp – gesetzt für einen externen Teilnehmer, der den Support per SMS oder WhatsApp kontaktiert; Antworten im Raum gehen über diesen Kanal zurück (MessengerSupportChatHelper).

  • messenger_phone_numberstring

    Mobilnummer des Messenger-Teilnehmers, E.164-Ziffern ohne +.

  • messenger_verified_atstring (date-time)

    Zeitpunkt, zu dem der Messenger verifiziert wurde.

  • left_atstring (date-time)

    Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange dies gesetzt ist, nimmt der Veranstaltungsabgleich sie nicht wieder auf.

  • left_reasonstring

    self | room_admin, siehe LEFT_REASON_*

  • notify_levelstring

    Wann diese Person eine Push-Benachrichtigung erhält: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer bedeutet: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.

  • muted_untilstring (date-time)

    Bis wann der Raum ganz stumm ist („für 8 Stunden aus“), danach gilt wieder notify_level.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • namestring

    Name der Einheit.

  • image_urlstring

    URL des Bildes des Datensatzes.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/chat/chatroom_participant/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "participant_type": "string",
  "chatroom": {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00",
    "deleted": true
  },
  "public_session": {
    "id": 42,
    "token": "string",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  },
  "nickname": "string",
  "preferred_color_hex": "string"
}

Aktualisiert einen vorhandenen ChatroomParticipant-Eintrag.

PUT/api/chat/chatroom_participant/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataChatroomParticipant3
    Felder anzeigen (31)
    • idinteger

      Primärschlüssel des Teilnehmers. Interne ID.

    • participant_typestring

      Art des Teilnehmers.

    • chatroomChatroom10

      Chatraum, zu dem der Teilnehmer gehört.

    • public_sessionPublicSession4

      Öffentliche Sitzung des Teilnehmers.

    • first_namestring

      Vorname des Teilnehmers.

    • last_namestring

      Nachname des Teilnehmers.

    • nicknamestring

      Spitzname der Teilnehmenden.

    • preferred_color_hexstring

      Bevorzugte Farbe des Teilnehmers als Hexwert.

    • avatar_tokenstring

      Token des Avatarbildes.

    • last_read_atstring (date-time)

      Zeitstempel des letzten Lesens des Chatraums durch diesen Teilnehmer

    • message_count_readinteger

      Anzahl der von der teilnehmenden Person gelesenen Nachrichten.

    • room_adminboolean

      Kennzeichen, ob dieser Teilnehmer Nachrichten im Chatraum löschen, den Chatraum umbenennen sowie Teilnehmer hinzufügen oder entfernen kann

    • can_writeboolean

      Kennzeichen, ob dieser Teilnehmer Nachrichten schreiben kann

    • is_mutedboolean

      Kennzeichen, ob dieser Teilnehmer Benachrichtigungen erhalten möchte

    • auto_createdboolean

      Kennzeichen, ob dieser Teilnehmer automatisch angelegt wurde, weil er einem Unternehmen oder einer Veranstaltung angehört

    • reply_modestring

      Überschreibung zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.

    • ai_auto_close_secret_wordstring

      Ein Wort als letzter Teil einer KI-Antwort, das den Chatraum schließt. Wird für KI-Bots verwendet.

    • ai_promptstring

      Der Systemprompt für den KI-Bot. Wird für KI-Bots verwendet.

    • ai_number_of_context_messagesinteger

      Die Anzahl der Nachrichten, die dem Kontext des KI-Bots hinzugefügt werden. Wird für KI-Bots verwendet.

    • messenger_channelstring

      sms | whatsapp – gesetzt für einen externen Teilnehmer, der den Support per SMS oder WhatsApp kontaktiert; Antworten im Raum gehen über diesen Kanal zurück (MessengerSupportChatHelper).

    • messenger_phone_numberstring

      Mobilnummer des Messenger-Teilnehmers, E.164-Ziffern ohne +.

    • messenger_verified_atstring (date-time)

      Zeitpunkt, zu dem der Messenger verifiziert wurde.

    • left_atstring (date-time)

      Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange dies gesetzt ist, nimmt der Veranstaltungsabgleich sie nicht wieder auf.

    • left_reasonstring

      self | room_admin, siehe LEFT_REASON_*

    • notify_levelstring

      Wann diese Person eine Push-Benachrichtigung erhält: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer bedeutet: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.

    • muted_untilstring (date-time)

      Bis wann der Raum ganz stumm ist („für 8 Stunden aus“), danach gilt wieder notify_level.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • namestring

      Name der Einheit.

    • image_urlstring

      URL des Bildes des Datensatzes.

Antworten

200ChatroomParticipant einzeln aktualisierenChatroomParticipant3

Felder anzeigen (31)
  • idinteger

    Primärschlüssel des Teilnehmers. Interne ID.

  • participant_typestring

    Art des Teilnehmers.

  • chatroomChatroom10

    Chatraum, zu dem der Teilnehmer gehört.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Chatraums. Interne ID.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • namestring

      Name der Einheit.

    • image_urlstring

      URL des Bildes des Datensatzes.

  • public_sessionPublicSession4

    Öffentliche Sitzung des Teilnehmers.

    Felder anzeigen (4)
    • idinteger

      Primärschlüssel der öffentlichen Sitzung. Interne ID.

    • tokenstring

      Token, das die öffentliche Sitzung identifiziert.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • first_namestring

    Vorname des Teilnehmers.

  • last_namestring

    Nachname des Teilnehmers.

  • nicknamestring

    Spitzname der Teilnehmenden.

  • preferred_color_hexstring

    Bevorzugte Farbe des Teilnehmers als Hexwert.

  • avatar_tokenstring

    Token des Avatarbildes.

  • last_read_atstring (date-time)

    Zeitstempel des letzten Lesens des Chatraums durch diesen Teilnehmer

  • message_count_readinteger

    Anzahl der von der teilnehmenden Person gelesenen Nachrichten.

  • room_adminboolean

    Kennzeichen, ob dieser Teilnehmer Nachrichten im Chatraum löschen, den Chatraum umbenennen sowie Teilnehmer hinzufügen oder entfernen kann

  • can_writeboolean

    Kennzeichen, ob dieser Teilnehmer Nachrichten schreiben kann

  • is_mutedboolean

    Kennzeichen, ob dieser Teilnehmer Benachrichtigungen erhalten möchte

  • auto_createdboolean

    Kennzeichen, ob dieser Teilnehmer automatisch angelegt wurde, weil er einem Unternehmen oder einer Veranstaltung angehört

  • reply_modestring

    Überschreibung zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.

  • ai_auto_close_secret_wordstring

    Ein Wort als letzter Teil einer KI-Antwort, das den Chatraum schließt. Wird für KI-Bots verwendet.

  • ai_promptstring

    Der Systemprompt für den KI-Bot. Wird für KI-Bots verwendet.

  • ai_number_of_context_messagesinteger

    Die Anzahl der Nachrichten, die dem Kontext des KI-Bots hinzugefügt werden. Wird für KI-Bots verwendet.

  • messenger_channelstring

    sms | whatsapp – gesetzt für einen externen Teilnehmer, der den Support per SMS oder WhatsApp kontaktiert; Antworten im Raum gehen über diesen Kanal zurück (MessengerSupportChatHelper).

  • messenger_phone_numberstring

    Mobilnummer des Messenger-Teilnehmers, E.164-Ziffern ohne +.

  • messenger_verified_atstring (date-time)

    Zeitpunkt, zu dem der Messenger verifiziert wurde.

  • left_atstring (date-time)

    Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange dies gesetzt ist, nimmt der Veranstaltungsabgleich sie nicht wieder auf.

  • left_reasonstring

    self | room_admin, siehe LEFT_REASON_*

  • notify_levelstring

    Wann diese Person eine Push-Benachrichtigung erhält: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer bedeutet: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.

  • muted_untilstring (date-time)

    Bis wann der Raum ganz stumm ist („für 8 Stunden aus“), danach gilt wieder notify_level.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • namestring

    Name der Einheit.

  • image_urlstring

    URL des Bildes des Datensatzes.

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/chat/chatroom_participant/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "participant_type": "string"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "participant_type": "string",
  "chatroom": {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00",
    "deleted": true
  },
  "public_session": {
    "id": 42,
    "token": "string",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  },
  "nickname": "string",
  "preferred_color_hex": "string"
}

Aktualisiert einen vorhandenen ChatroomParticipant-Eintrag.

PATCH/api/chat/chatroom_participant/{identifier}

Pfad-Parameter

identifierPflichtstring

Request-Body application/json

  • dataChatroomParticipant3
    Felder anzeigen (31)
    • idinteger

      Primärschlüssel des Teilnehmers. Interne ID.

    • participant_typestring

      Art des Teilnehmers.

    • chatroomChatroom10

      Chatraum, zu dem der Teilnehmer gehört.

    • public_sessionPublicSession4

      Öffentliche Sitzung des Teilnehmers.

    • first_namestring

      Vorname des Teilnehmers.

    • last_namestring

      Nachname des Teilnehmers.

    • nicknamestring

      Spitzname der Teilnehmenden.

    • preferred_color_hexstring

      Bevorzugte Farbe des Teilnehmers als Hexwert.

    • avatar_tokenstring

      Token des Avatarbildes.

    • last_read_atstring (date-time)

      Zeitstempel des letzten Lesens des Chatraums durch diesen Teilnehmer

    • message_count_readinteger

      Anzahl der von der teilnehmenden Person gelesenen Nachrichten.

    • room_adminboolean

      Kennzeichen, ob dieser Teilnehmer Nachrichten im Chatraum löschen, den Chatraum umbenennen sowie Teilnehmer hinzufügen oder entfernen kann

    • can_writeboolean

      Kennzeichen, ob dieser Teilnehmer Nachrichten schreiben kann

    • is_mutedboolean

      Kennzeichen, ob dieser Teilnehmer Benachrichtigungen erhalten möchte

    • auto_createdboolean

      Kennzeichen, ob dieser Teilnehmer automatisch angelegt wurde, weil er einem Unternehmen oder einer Veranstaltung angehört

    • reply_modestring

      Überschreibung zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.

    • ai_auto_close_secret_wordstring

      Ein Wort als letzter Teil einer KI-Antwort, das den Chatraum schließt. Wird für KI-Bots verwendet.

    • ai_promptstring

      Der Systemprompt für den KI-Bot. Wird für KI-Bots verwendet.

    • ai_number_of_context_messagesinteger

      Die Anzahl der Nachrichten, die dem Kontext des KI-Bots hinzugefügt werden. Wird für KI-Bots verwendet.

    • messenger_channelstring

      sms | whatsapp – gesetzt für einen externen Teilnehmer, der den Support per SMS oder WhatsApp kontaktiert; Antworten im Raum gehen über diesen Kanal zurück (MessengerSupportChatHelper).

    • messenger_phone_numberstring

      Mobilnummer des Messenger-Teilnehmers, E.164-Ziffern ohne +.

    • messenger_verified_atstring (date-time)

      Zeitpunkt, zu dem der Messenger verifiziert wurde.

    • left_atstring (date-time)

      Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange dies gesetzt ist, nimmt der Veranstaltungsabgleich sie nicht wieder auf.

    • left_reasonstring

      self | room_admin, siehe LEFT_REASON_*

    • notify_levelstring

      Wann diese Person eine Push-Benachrichtigung erhält: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer bedeutet: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.

    • muted_untilstring (date-time)

      Bis wann der Raum ganz stumm ist („für 8 Stunden aus“), danach gilt wieder notify_level.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • namestring

      Name der Einheit.

    • image_urlstring

      URL des Bildes des Datensatzes.

Antworten

200ChatroomParticipant einzeln aktualisierenChatroomParticipant3

Felder anzeigen (31)
  • idinteger

    Primärschlüssel des Teilnehmers. Interne ID.

  • participant_typestring

    Art des Teilnehmers.

  • chatroomChatroom10

    Chatraum, zu dem der Teilnehmer gehört.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Chatraums. Interne ID.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • namestring

      Name der Einheit.

    • image_urlstring

      URL des Bildes des Datensatzes.

  • public_sessionPublicSession4

    Öffentliche Sitzung des Teilnehmers.

    Felder anzeigen (4)
    • idinteger

      Primärschlüssel der öffentlichen Sitzung. Interne ID.

    • tokenstring

      Token, das die öffentliche Sitzung identifiziert.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • first_namestring

    Vorname des Teilnehmers.

  • last_namestring

    Nachname des Teilnehmers.

  • nicknamestring

    Spitzname der Teilnehmenden.

  • preferred_color_hexstring

    Bevorzugte Farbe des Teilnehmers als Hexwert.

  • avatar_tokenstring

    Token des Avatarbildes.

  • last_read_atstring (date-time)

    Zeitstempel des letzten Lesens des Chatraums durch diesen Teilnehmer

  • message_count_readinteger

    Anzahl der von der teilnehmenden Person gelesenen Nachrichten.

  • room_adminboolean

    Kennzeichen, ob dieser Teilnehmer Nachrichten im Chatraum löschen, den Chatraum umbenennen sowie Teilnehmer hinzufügen oder entfernen kann

  • can_writeboolean

    Kennzeichen, ob dieser Teilnehmer Nachrichten schreiben kann

  • is_mutedboolean

    Kennzeichen, ob dieser Teilnehmer Benachrichtigungen erhalten möchte

  • auto_createdboolean

    Kennzeichen, ob dieser Teilnehmer automatisch angelegt wurde, weil er einem Unternehmen oder einer Veranstaltung angehört

  • reply_modestring

    Überschreibung zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.

  • ai_auto_close_secret_wordstring

    Ein Wort als letzter Teil einer KI-Antwort, das den Chatraum schließt. Wird für KI-Bots verwendet.

  • ai_promptstring

    Der Systemprompt für den KI-Bot. Wird für KI-Bots verwendet.

  • ai_number_of_context_messagesinteger

    Die Anzahl der Nachrichten, die dem Kontext des KI-Bots hinzugefügt werden. Wird für KI-Bots verwendet.

  • messenger_channelstring

    sms | whatsapp – gesetzt für einen externen Teilnehmer, der den Support per SMS oder WhatsApp kontaktiert; Antworten im Raum gehen über diesen Kanal zurück (MessengerSupportChatHelper).

  • messenger_phone_numberstring

    Mobilnummer des Messenger-Teilnehmers, E.164-Ziffern ohne +.

  • messenger_verified_atstring (date-time)

    Zeitpunkt, zu dem der Messenger verifiziert wurde.

  • left_atstring (date-time)

    Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange dies gesetzt ist, nimmt der Veranstaltungsabgleich sie nicht wieder auf.

  • left_reasonstring

    self | room_admin, siehe LEFT_REASON_*

  • notify_levelstring

    Wann diese Person eine Push-Benachrichtigung erhält: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer bedeutet: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.

  • muted_untilstring (date-time)

    Bis wann der Raum ganz stumm ist („für 8 Stunden aus“), danach gilt wieder notify_level.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • namestring

    Name der Einheit.

  • image_urlstring

    URL des Bildes des Datensatzes.

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/chat/chatroom_participant/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "participant_type": "string"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "participant_type": "string",
  "chatroom": {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00",
    "deleted": true
  },
  "public_session": {
    "id": 42,
    "token": "string",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  },
  "nickname": "string",
  "preferred_color_hex": "string"
}

Einen einzelnen ChatroomParticipant löschen

DELETE/api/chat/chatroom_participant/{identifier}

Pfad-Parameter

identifierPflichtstring

Antworten

200Gibt ein einzelnes ChatroomParticipant-Objekt zurück.ChatroomParticipant3

Felder anzeigen (31)
  • idinteger

    Primärschlüssel des Teilnehmers. Interne ID.

  • participant_typestring

    Art des Teilnehmers.

  • chatroomChatroom10

    Chatraum, zu dem der Teilnehmer gehört.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Chatraums. Interne ID.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

    • deletedboolean

      Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

    • namestring

      Name der Einheit.

    • image_urlstring

      URL des Bildes des Datensatzes.

  • public_sessionPublicSession4

    Öffentliche Sitzung des Teilnehmers.

    Felder anzeigen (4)
    • idinteger

      Primärschlüssel der öffentlichen Sitzung. Interne ID.

    • tokenstring

      Token, das die öffentliche Sitzung identifiziert.

    • createdstring (date-time)

      Zeitpunkt, zu dem der Datensatz angelegt wurde.

    • updatedstring (date-time)

      Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • first_namestring

    Vorname des Teilnehmers.

  • last_namestring

    Nachname des Teilnehmers.

  • nicknamestring

    Spitzname der Teilnehmenden.

  • preferred_color_hexstring

    Bevorzugte Farbe des Teilnehmers als Hexwert.

  • avatar_tokenstring

    Token des Avatarbildes.

  • last_read_atstring (date-time)

    Zeitstempel des letzten Lesens des Chatraums durch diesen Teilnehmer

  • message_count_readinteger

    Anzahl der von der teilnehmenden Person gelesenen Nachrichten.

  • room_adminboolean

    Kennzeichen, ob dieser Teilnehmer Nachrichten im Chatraum löschen, den Chatraum umbenennen sowie Teilnehmer hinzufügen oder entfernen kann

  • can_writeboolean

    Kennzeichen, ob dieser Teilnehmer Nachrichten schreiben kann

  • is_mutedboolean

    Kennzeichen, ob dieser Teilnehmer Benachrichtigungen erhalten möchte

  • auto_createdboolean

    Kennzeichen, ob dieser Teilnehmer automatisch angelegt wurde, weil er einem Unternehmen oder einer Veranstaltung angehört

  • reply_modestring

    Überschreibung zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.

  • ai_auto_close_secret_wordstring

    Ein Wort als letzter Teil einer KI-Antwort, das den Chatraum schließt. Wird für KI-Bots verwendet.

  • ai_promptstring

    Der Systemprompt für den KI-Bot. Wird für KI-Bots verwendet.

  • ai_number_of_context_messagesinteger

    Die Anzahl der Nachrichten, die dem Kontext des KI-Bots hinzugefügt werden. Wird für KI-Bots verwendet.

  • messenger_channelstring

    sms | whatsapp – gesetzt für einen externen Teilnehmer, der den Support per SMS oder WhatsApp kontaktiert; Antworten im Raum gehen über diesen Kanal zurück (MessengerSupportChatHelper).

  • messenger_phone_numberstring

    Mobilnummer des Messenger-Teilnehmers, E.164-Ziffern ohne +.

  • messenger_verified_atstring (date-time)

    Zeitpunkt, zu dem der Messenger verifiziert wurde.

  • left_atstring (date-time)

    Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange dies gesetzt ist, nimmt der Veranstaltungsabgleich sie nicht wieder auf.

  • left_reasonstring

    self | room_admin, siehe LEFT_REASON_*

  • notify_levelstring

    Wann diese Person eine Push-Benachrichtigung erhält: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer bedeutet: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.

  • muted_untilstring (date-time)

    Bis wann der Raum ganz stumm ist („für 8 Stunden aus“), danach gilt wieder notify_level.

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • updatedstring (date-time)

    Zeitpunkt, zu dem der Datensatz zuletzt aktualisiert wurde.

  • deletedboolean

    Diese Eigenschaft markiert eine Entität als gelöscht / archiviert

  • namestring

    Name der Einheit.

  • image_urlstring

    URL des Bildes des Datensatzes.

Anfrage
curl --request DELETE \
  --url https://eure-instanz.iw-erp.de/api/chat/chatroom_participant/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "participant_type": "string",
  "chatroom": {
    "id": 42,
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00",
    "deleted": true
  },
  "public_session": {
    "id": 42,
    "token": "string",
    "created": "2026-10-15T09:30:00+02:00",
    "updated": "2026-10-15T09:30:00+02:00"
  },
  "nickname": "string",
  "preferred_color_hex": "string"
}