ChatroomParticipant

Chat and notifications6 EndpointsChat / ChatroomParticipant

Returns a list of all ChatroomParticipants

GET/api/chat/chatroom_participant

Query parameters

`chatroom`string	_LIST
`person`string	_LIST
`company`string	_LIST
`eventSignUp`string	_LIST
`deleted`boolean	This property is used to mark an entity as deleted / archived \| _LIST
`participantType`string	_LIST
`chatbotProfile`string	Das Profil, aus dem dieser Bot-Teilnehmer seine Vorgaben zieht. Nur bei participantType internal_ai_bot gesetzt. \| _LIST
`searchString`string	text to search for in the list
`orderFieldName`string	name of the order field
`orderFieldSort`string	sorting modeAllowed: `DESCASC`
`page`integer	page of the list
`pageSize`integer	number of entries for each page
`withMaxPageNumber`string	returns the number of pages available as a header if this is set

Responses

200Returns a list of all ChatroomParticipantsarray<ChatroomParticipant2>

Show fields (24)

idinteger
Primary key of the participant. Internal ID.
participant_typestring
Type of the participant.
first_namestring
First name of the participant.
last_namestring
Last name of the participant.
nicknamestring
Nickname of the participant.
preferred_color_hexstring
Preferred color of the participant as hex value.
avatar_tokenstring
Token of the avatar image.
last_read_atstring (date-time)
A timestamp of the last time this participant read the chatroom
message_count_readinteger
Number of messages read by the participant.
room_adminboolean
A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants
can_writeboolean
A flag to indicate if this participant can write messages
is_mutedboolean
A flag to indicate if this participant wants to receive notifications
messenger_channelstring
sms | whatsapp - set for an external participant who writes to the support over SMS or WhatsApp; answers in the room go back over this channel (MessengerSupportChatHelper).
messenger_phone_numberstring
Mobile number of the messenger participant, E.164 digits without +.
messenger_verified_atstring (date-time)
Point in time the messenger was verified.
left_atstring (date-time)
Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange das gesetzt ist, nimmt der Event-Abgleich sie nicht wieder auf.
left_reasonstring
self | room_admin, siehe LEFT_REASON_*
notify_levelstring
Wann diese Person eine Push-Benachrichtigung bekommt: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer heisst: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.
muted_untilstring (date-time)
Bis wann der Raum ganz stumm ist ("fuer 8 Stunden aus"), danach gilt wieder notify_level.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
image_urlstring
URL of the image of the entity.

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/chat/chatroom_participant \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/chat/chatroom_participant', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/chat/chatroom_participant"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/chat/chatroom_participant', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/chat/chatroom_participant"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/chat/chatroom_participant")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/chat/chatroom_participant"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/chatroom_participant_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await ChatroomParticipantController.getAll();
if (result.success) {
  print(result.data);
}

Response 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"
  }
]

Add a new ChatroomParticipant

POST/api/chat/chatroom_participant

Request body application/json

dataChatroomParticipant3
Show fields (31)
- idinteger
  Primary key of the participant. Internal ID.
- participant_typestring
  Type of the participant.
- chatroomChatroom10
  Chat room the participant belongs to.
- public_sessionPublicSession4
  Public session of the participant.
- first_namestring
  First name of the participant.
- last_namestring
  Last name of the participant.
- nicknamestring
  Nickname of the participant.
- preferred_color_hexstring
  Preferred color of the participant as hex value.
- avatar_tokenstring
  Token of the avatar image.
- last_read_atstring (date-time)
  A timestamp of the last time this participant read the chatroom
- message_count_readinteger
  Number of messages read by the participant.
- room_adminboolean
  A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants
- can_writeboolean
  A flag to indicate if this participant can write messages
- is_mutedboolean
  A flag to indicate if this participant wants to receive notifications
- auto_createdboolean
  A flag to indicate if this participant was auto created by being in a company or event
- reply_modestring
  Override zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.
- ai_auto_close_secret_wordstring
  A word as the last part of an ai reply that will close the chatroom. Used for AI bots.
- ai_promptstring
  The system prompt for the AI bot. Used for AI bots.
- ai_number_of_context_messagesinteger
  The number of messages we add to the context of the AI bot. Used for AI bots.
- messenger_channelstring
  sms | whatsapp - set for an external participant who writes to the support over SMS or WhatsApp; answers in the room go back over this channel (MessengerSupportChatHelper).
- messenger_phone_numberstring
  Mobile number of the messenger participant, E.164 digits without +.
- messenger_verified_atstring (date-time)
  Point in time the messenger was verified.
- left_atstring (date-time)
  Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange das gesetzt ist, nimmt der Event-Abgleich sie nicht wieder auf.
- left_reasonstring
  self | room_admin, siehe LEFT_REASON_*
- notify_levelstring
  Wann diese Person eine Push-Benachrichtigung bekommt: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer heisst: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.
- muted_untilstring (date-time)
  Bis wann der Raum ganz stumm ist ("fuer 8 Stunden aus"), danach gilt wieder notify_level.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
- image_urlstring
  URL of the image of the entity.

Responses

200Add a new ChatroomParticipantChatroomParticipant3

Show fields (31)

idinteger
Primary key of the participant. Internal ID.
participant_typestring
Type of the participant.
chatroomChatroom10
Chat room the participant belongs to.
Show fields (6)
- idinteger
  Primary key of the chat room. Internal ID.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
- image_urlstring
  URL of the image of the entity.
public_sessionPublicSession4
Public session of the participant.
Show fields (4)
- idinteger
  Primary key of the public session. Internal ID.
- tokenstring
  Token that identifies the public session.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
first_namestring
First name of the participant.
last_namestring
Last name of the participant.
nicknamestring
Nickname of the participant.
preferred_color_hexstring
Preferred color of the participant as hex value.
avatar_tokenstring
Token of the avatar image.
last_read_atstring (date-time)
A timestamp of the last time this participant read the chatroom
message_count_readinteger
Number of messages read by the participant.
room_adminboolean
A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants
can_writeboolean
A flag to indicate if this participant can write messages
is_mutedboolean
A flag to indicate if this participant wants to receive notifications
auto_createdboolean
A flag to indicate if this participant was auto created by being in a company or event
reply_modestring
Override zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.
ai_auto_close_secret_wordstring
A word as the last part of an ai reply that will close the chatroom. Used for AI bots.
ai_promptstring
The system prompt for the AI bot. Used for AI bots.
ai_number_of_context_messagesinteger
The number of messages we add to the context of the AI bot. Used for AI bots.
messenger_channelstring
sms | whatsapp - set for an external participant who writes to the support over SMS or WhatsApp; answers in the room go back over this channel (MessengerSupportChatHelper).
messenger_phone_numberstring
Mobile number of the messenger participant, E.164 digits without +.
messenger_verified_atstring (date-time)
Point in time the messenger was verified.
left_atstring (date-time)
Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange das gesetzt ist, nimmt der Event-Abgleich sie nicht wieder auf.
left_reasonstring
self | room_admin, siehe LEFT_REASON_*
notify_levelstring
Wann diese Person eine Push-Benachrichtigung bekommt: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer heisst: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.
muted_untilstring (date-time)
Bis wann der Raum ganz stumm ist ("fuer 8 Stunden aus"), danach gilt wieder notify_level.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
image_urlstring
URL of the image of the entity.

Request

curl --request POST \
  --url https://your-instance.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"
  }
}
'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      id: 42,
      first_name: 'Lena',
      last_name: 'Hartmann',
      name: 'Beispiel',
      image_url: 'https://vynst.de',
      participant_type: 'string'
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/chat/chatroom_participant', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/chat/chatroom_participant"

payload = { "data": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "participant_type": "string"
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/chat/chatroom_participant', [
  'body' => '{"data":{"id":42,"first_name":"Lena","last_name":"Hartmann","name":"Beispiel","image_url":"https://vynst.de","participant_type":"string"}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/chat/chatroom_participant"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"id\":42,\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"participant_type\":\"string\"}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"id\":42,\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"participant_type\":\"string\"}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/chat/chatroom_participant")
  .post(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/chat/chatroom_participant"

	payload := strings.NewReader("{\"data\":{\"id\":42,\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"participant_type\":\"string\"}}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/chatroom_participant_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/chatroom_participant.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await ChatroomParticipantController.post(ChatroomParticipant.fromJson({
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "participant_type": "string"
}));
if (result.success) {
  print(result.data);
}

Response 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"
}

Returns a single ChatroomParticipant entry.

GET/api/chat/chatroom_participant/{identifier}

Path parameters

identifierrequiredstring

Responses

200Return single ChatroomParticipantChatroomParticipant3

Show fields (31)

idinteger
Primary key of the participant. Internal ID.
participant_typestring
Type of the participant.
chatroomChatroom10
Chat room the participant belongs to.
Show fields (6)
- idinteger
  Primary key of the chat room. Internal ID.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
- image_urlstring
  URL of the image of the entity.
public_sessionPublicSession4
Public session of the participant.
Show fields (4)
- idinteger
  Primary key of the public session. Internal ID.
- tokenstring
  Token that identifies the public session.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
first_namestring
First name of the participant.
last_namestring
Last name of the participant.
nicknamestring
Nickname of the participant.
preferred_color_hexstring
Preferred color of the participant as hex value.
avatar_tokenstring
Token of the avatar image.
last_read_atstring (date-time)
A timestamp of the last time this participant read the chatroom
message_count_readinteger
Number of messages read by the participant.
room_adminboolean
A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants
can_writeboolean
A flag to indicate if this participant can write messages
is_mutedboolean
A flag to indicate if this participant wants to receive notifications
auto_createdboolean
A flag to indicate if this participant was auto created by being in a company or event
reply_modestring
Override zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.
ai_auto_close_secret_wordstring
A word as the last part of an ai reply that will close the chatroom. Used for AI bots.
ai_promptstring
The system prompt for the AI bot. Used for AI bots.
ai_number_of_context_messagesinteger
The number of messages we add to the context of the AI bot. Used for AI bots.
messenger_channelstring
sms | whatsapp - set for an external participant who writes to the support over SMS or WhatsApp; answers in the room go back over this channel (MessengerSupportChatHelper).
messenger_phone_numberstring
Mobile number of the messenger participant, E.164 digits without +.
messenger_verified_atstring (date-time)
Point in time the messenger was verified.
left_atstring (date-time)
Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange das gesetzt ist, nimmt der Event-Abgleich sie nicht wieder auf.
left_reasonstring
self | room_admin, siehe LEFT_REASON_*
notify_levelstring
Wann diese Person eine Push-Benachrichtigung bekommt: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer heisst: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.
muted_untilstring (date-time)
Bis wann der Raum ganz stumm ist ("fuer 8 Stunden aus"), danach gilt wieder notify_level.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
image_urlstring
URL of the image of the entity.

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/chat/chatroom_participant/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/chat/chatroom_participant/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/chat/chatroom_participant/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/chat/chatroom_participant/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/chat/chatroom_participant/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/chat/chatroom_participant/42")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/chat/chatroom_participant/42"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/chatroom_participant_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await ChatroomParticipantController.get('42');
if (result.success) {
  print(result.data);
}

Response 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"
}

Updates an existing ChatroomParticipant entry.

PUT/api/chat/chatroom_participant/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

dataChatroomParticipant3
Show fields (31)
- idinteger
  Primary key of the participant. Internal ID.
- participant_typestring
  Type of the participant.
- chatroomChatroom10
  Chat room the participant belongs to.
- public_sessionPublicSession4
  Public session of the participant.
- first_namestring
  First name of the participant.
- last_namestring
  Last name of the participant.
- nicknamestring
  Nickname of the participant.
- preferred_color_hexstring
  Preferred color of the participant as hex value.
- avatar_tokenstring
  Token of the avatar image.
- last_read_atstring (date-time)
  A timestamp of the last time this participant read the chatroom
- message_count_readinteger
  Number of messages read by the participant.
- room_adminboolean
  A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants
- can_writeboolean
  A flag to indicate if this participant can write messages
- is_mutedboolean
  A flag to indicate if this participant wants to receive notifications
- auto_createdboolean
  A flag to indicate if this participant was auto created by being in a company or event
- reply_modestring
  Override zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.
- ai_auto_close_secret_wordstring
  A word as the last part of an ai reply that will close the chatroom. Used for AI bots.
- ai_promptstring
  The system prompt for the AI bot. Used for AI bots.
- ai_number_of_context_messagesinteger
  The number of messages we add to the context of the AI bot. Used for AI bots.
- messenger_channelstring
  sms | whatsapp - set for an external participant who writes to the support over SMS or WhatsApp; answers in the room go back over this channel (MessengerSupportChatHelper).
- messenger_phone_numberstring
  Mobile number of the messenger participant, E.164 digits without +.
- messenger_verified_atstring (date-time)
  Point in time the messenger was verified.
- left_atstring (date-time)
  Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange das gesetzt ist, nimmt der Event-Abgleich sie nicht wieder auf.
- left_reasonstring
  self | room_admin, siehe LEFT_REASON_*
- notify_levelstring
  Wann diese Person eine Push-Benachrichtigung bekommt: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer heisst: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.
- muted_untilstring (date-time)
  Bis wann der Raum ganz stumm ist ("fuer 8 Stunden aus"), danach gilt wieder notify_level.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
- image_urlstring
  URL of the image of the entity.

Responses

200Update single ChatroomParticipantChatroomParticipant3

Show fields (31)

idinteger
Primary key of the participant. Internal ID.
participant_typestring
Type of the participant.
chatroomChatroom10
Chat room the participant belongs to.
Show fields (6)
- idinteger
  Primary key of the chat room. Internal ID.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
- image_urlstring
  URL of the image of the entity.
public_sessionPublicSession4
Public session of the participant.
Show fields (4)
- idinteger
  Primary key of the public session. Internal ID.
- tokenstring
  Token that identifies the public session.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
first_namestring
First name of the participant.
last_namestring
Last name of the participant.
nicknamestring
Nickname of the participant.
preferred_color_hexstring
Preferred color of the participant as hex value.
avatar_tokenstring
Token of the avatar image.
last_read_atstring (date-time)
A timestamp of the last time this participant read the chatroom
message_count_readinteger
Number of messages read by the participant.
room_adminboolean
A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants
can_writeboolean
A flag to indicate if this participant can write messages
is_mutedboolean
A flag to indicate if this participant wants to receive notifications
auto_createdboolean
A flag to indicate if this participant was auto created by being in a company or event
reply_modestring
Override zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.
ai_auto_close_secret_wordstring
A word as the last part of an ai reply that will close the chatroom. Used for AI bots.
ai_promptstring
The system prompt for the AI bot. Used for AI bots.
ai_number_of_context_messagesinteger
The number of messages we add to the context of the AI bot. Used for AI bots.
messenger_channelstring
sms | whatsapp - set for an external participant who writes to the support over SMS or WhatsApp; answers in the room go back over this channel (MessengerSupportChatHelper).
messenger_phone_numberstring
Mobile number of the messenger participant, E.164 digits without +.
messenger_verified_atstring (date-time)
Point in time the messenger was verified.
left_atstring (date-time)
Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange das gesetzt ist, nimmt der Event-Abgleich sie nicht wieder auf.
left_reasonstring
self | room_admin, siehe LEFT_REASON_*
notify_levelstring
Wann diese Person eine Push-Benachrichtigung bekommt: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer heisst: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.
muted_untilstring (date-time)
Bis wann der Raum ganz stumm ist ("fuer 8 Stunden aus"), danach gilt wieder notify_level.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
image_urlstring
URL of the image of the entity.

Request

curl --request PUT \
  --url https://your-instance.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"
  }
}
'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      id: 42,
      first_name: 'Lena',
      last_name: 'Hartmann',
      name: 'Beispiel',
      image_url: 'https://vynst.de',
      participant_type: 'string'
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/chat/chatroom_participant/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/chat/chatroom_participant/42"

payload = { "data": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "participant_type": "string"
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://your-instance.iw-erp.de/api/chat/chatroom_participant/42', [
  'body' => '{"data":{"id":42,"first_name":"Lena","last_name":"Hartmann","name":"Beispiel","image_url":"https://vynst.de","participant_type":"string"}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Put,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/chat/chatroom_participant/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"id\":42,\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"participant_type\":\"string\"}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"id\":42,\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"participant_type\":\"string\"}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/chat/chatroom_participant/42")
  .put(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/chat/chatroom_participant/42"

	payload := strings.NewReader("{\"data\":{\"id\":42,\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"participant_type\":\"string\"}}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/chatroom_participant_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/chatroom_participant.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await ChatroomParticipantController.put(ChatroomParticipant.fromJson({
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "name": "Beispiel",
  "image_url": "https://vynst.de",
  "participant_type": "string"
}));
if (result.success) {
  print(result.data);
}

Response 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"
}

Updates an existing ChatroomParticipant entry.

PATCH/api/chat/chatroom_participant/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

dataChatroomParticipant3
Show fields (31)
- idinteger
  Primary key of the participant. Internal ID.
- participant_typestring
  Type of the participant.
- chatroomChatroom10
  Chat room the participant belongs to.
- public_sessionPublicSession4
  Public session of the participant.
- first_namestring
  First name of the participant.
- last_namestring
  Last name of the participant.
- nicknamestring
  Nickname of the participant.
- preferred_color_hexstring
  Preferred color of the participant as hex value.
- avatar_tokenstring
  Token of the avatar image.
- last_read_atstring (date-time)
  A timestamp of the last time this participant read the chatroom
- message_count_readinteger
  Number of messages read by the participant.
- room_adminboolean
  A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants
- can_writeboolean
  A flag to indicate if this participant can write messages
- is_mutedboolean
  A flag to indicate if this participant wants to receive notifications
- auto_createdboolean
  A flag to indicate if this participant was auto created by being in a company or event
- reply_modestring
  Override zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.
- ai_auto_close_secret_wordstring
  A word as the last part of an ai reply that will close the chatroom. Used for AI bots.
- ai_promptstring
  The system prompt for the AI bot. Used for AI bots.
- ai_number_of_context_messagesinteger
  The number of messages we add to the context of the AI bot. Used for AI bots.
- messenger_channelstring
  sms | whatsapp - set for an external participant who writes to the support over SMS or WhatsApp; answers in the room go back over this channel (MessengerSupportChatHelper).
- messenger_phone_numberstring
  Mobile number of the messenger participant, E.164 digits without +.
- messenger_verified_atstring (date-time)
  Point in time the messenger was verified.
- left_atstring (date-time)
  Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange das gesetzt ist, nimmt der Event-Abgleich sie nicht wieder auf.
- left_reasonstring
  self | room_admin, siehe LEFT_REASON_*
- notify_levelstring
  Wann diese Person eine Push-Benachrichtigung bekommt: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer heisst: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.
- muted_untilstring (date-time)
  Bis wann der Raum ganz stumm ist ("fuer 8 Stunden aus"), danach gilt wieder notify_level.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
- image_urlstring
  URL of the image of the entity.

Responses

200Update single ChatroomParticipantChatroomParticipant3

Show fields (31)

idinteger
Primary key of the participant. Internal ID.
participant_typestring
Type of the participant.
chatroomChatroom10
Chat room the participant belongs to.
Show fields (6)
- idinteger
  Primary key of the chat room. Internal ID.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
- image_urlstring
  URL of the image of the entity.
public_sessionPublicSession4
Public session of the participant.
Show fields (4)
- idinteger
  Primary key of the public session. Internal ID.
- tokenstring
  Token that identifies the public session.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
first_namestring
First name of the participant.
last_namestring
Last name of the participant.
nicknamestring
Nickname of the participant.
preferred_color_hexstring
Preferred color of the participant as hex value.
avatar_tokenstring
Token of the avatar image.
last_read_atstring (date-time)
A timestamp of the last time this participant read the chatroom
message_count_readinteger
Number of messages read by the participant.
room_adminboolean
A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants
can_writeboolean
A flag to indicate if this participant can write messages
is_mutedboolean
A flag to indicate if this participant wants to receive notifications
auto_createdboolean
A flag to indicate if this participant was auto created by being in a company or event
reply_modestring
Override zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.
ai_auto_close_secret_wordstring
A word as the last part of an ai reply that will close the chatroom. Used for AI bots.
ai_promptstring
The system prompt for the AI bot. Used for AI bots.
ai_number_of_context_messagesinteger
The number of messages we add to the context of the AI bot. Used for AI bots.
messenger_channelstring
sms | whatsapp - set for an external participant who writes to the support over SMS or WhatsApp; answers in the room go back over this channel (MessengerSupportChatHelper).
messenger_phone_numberstring
Mobile number of the messenger participant, E.164 digits without +.
messenger_verified_atstring (date-time)
Point in time the messenger was verified.
left_atstring (date-time)
Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange das gesetzt ist, nimmt der Event-Abgleich sie nicht wieder auf.
left_reasonstring
self | room_admin, siehe LEFT_REASON_*
notify_levelstring
Wann diese Person eine Push-Benachrichtigung bekommt: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer heisst: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.
muted_untilstring (date-time)
Bis wann der Raum ganz stumm ist ("fuer 8 Stunden aus"), danach gilt wieder notify_level.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
image_urlstring
URL of the image of the entity.

Request

curl --request PATCH \
  --url https://your-instance.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"
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    data: {
      id: 42,
      first_name: 'Lena',
      last_name: 'Hartmann',
      name: 'Beispiel',
      image_url: 'https://vynst.de',
      participant_type: 'string'
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/chat/chatroom_participant/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/chat/chatroom_participant/42"

payload = { "data": {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "name": "Beispiel",
    "image_url": "https://vynst.de",
    "participant_type": "string"
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://your-instance.iw-erp.de/api/chat/chatroom_participant/42', [
  'body' => '{"data":{"id":42,"first_name":"Lena","last_name":"Hartmann","name":"Beispiel","image_url":"https://vynst.de","participant_type":"string"}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Patch,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/chat/chatroom_participant/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"data\":{\"id\":42,\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"participant_type\":\"string\"}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"data\":{\"id\":42,\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"participant_type\":\"string\"}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/chat/chatroom_participant/42")
  .patch(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/chat/chatroom_participant/42"

	payload := strings.NewReader("{\"data\":{\"id\":42,\"first_name\":\"Lena\",\"last_name\":\"Hartmann\",\"name\":\"Beispiel\",\"image_url\":\"https://vynst.de\",\"participant_type\":\"string\"}}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with package:http (no controller in the iw_erp_api package)

import 'dart:convert';
import 'package:http/http.dart' as http;

final response = await http.patch(
  Uri.parse('https://your-instance.iw-erp.de/api/chat/chatroom_participant/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: jsonEncode({
    "data": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "name": "Beispiel",
      "image_url": "https://vynst.de",
      "participant_type": "string"
    }
  }),
);
print(response.body);

Response 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"
}

Delete a single ChatroomParticipant

DELETE/api/chat/chatroom_participant/{identifier}

Path parameters

identifierrequiredstring

Responses

200Return single ChatroomParticipantChatroomParticipant3

Show fields (31)

idinteger
Primary key of the participant. Internal ID.
participant_typestring
Type of the participant.
chatroomChatroom10
Chat room the participant belongs to.
Show fields (6)
- idinteger
  Primary key of the chat room. Internal ID.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- deletedboolean
  This property is used to mark an entity as deleted / archived
- namestring
  Name of the entity.
- image_urlstring
  URL of the image of the entity.
public_sessionPublicSession4
Public session of the participant.
Show fields (4)
- idinteger
  Primary key of the public session. Internal ID.
- tokenstring
  Token that identifies the public session.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
first_namestring
First name of the participant.
last_namestring
Last name of the participant.
nicknamestring
Nickname of the participant.
preferred_color_hexstring
Preferred color of the participant as hex value.
avatar_tokenstring
Token of the avatar image.
last_read_atstring (date-time)
A timestamp of the last time this participant read the chatroom
message_count_readinteger
Number of messages read by the participant.
room_adminboolean
A flag to indicate if this participant can delete messages in the chatroom + rename the chatroom + add or remove participants
can_writeboolean
A flag to indicate if this participant can write messages
is_mutedboolean
A flag to indicate if this participant wants to receive notifications
auto_createdboolean
A flag to indicate if this participant was auto created by being in a company or event
reply_modestring
Override zum Antwortmodus des Profils: always | mention | question. Leer heisst: der Wert aus dem Profil gilt.
ai_auto_close_secret_wordstring
A word as the last part of an ai reply that will close the chatroom. Used for AI bots.
ai_promptstring
The system prompt for the AI bot. Used for AI bots.
ai_number_of_context_messagesinteger
The number of messages we add to the context of the AI bot. Used for AI bots.
messenger_channelstring
sms | whatsapp - set for an external participant who writes to the support over SMS or WhatsApp; answers in the room go back over this channel (MessengerSupportChatHelper).
messenger_phone_numberstring
Mobile number of the messenger participant, E.164 digits without +.
messenger_verified_atstring (date-time)
Point in time the messenger was verified.
left_atstring (date-time)
Wann die Person den Raum verlassen hat bzw. von einem Raum-Admin entfernt wurde. Solange das gesetzt ist, nimmt der Event-Abgleich sie nicht wieder auf.
left_reasonstring
self | room_admin, siehe LEFT_REASON_*
notify_levelstring
Wann diese Person eine Push-Benachrichtigung bekommt: all | mentions | none, siehe NOTIFY_LEVEL_* (Einstellung chatroom_mute_enabled). Leer heisst: is_muted entscheidet (alt, von der Verwaltung gesetzt), sonst alle.
muted_untilstring (date-time)
Bis wann der Raum ganz stumm ist ("fuer 8 Stunden aus"), danach gilt wieder notify_level.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.
deletedboolean
This property is used to mark an entity as deleted / archived
namestring
Name of the entity.
image_urlstring
URL of the image of the entity.

Request

curl --request DELETE \
  --url https://your-instance.iw-erp.de/api/chat/chatroom_participant/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'DELETE', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/chat/chatroom_participant/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/chat/chatroom_participant/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.delete(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'https://your-instance.iw-erp.de/api/chat/chatroom_participant/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Delete,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/chat/chatroom_participant/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/chat/chatroom_participant/42")
  .delete(null)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/chat/chatroom_participant/42"

	req, _ := http.NewRequest("DELETE", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/chatroom_participant_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await ChatroomParticipantController.delete('42');
if (result.success) {
  print(result.data);
}

Response 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"
}