CrmMessage

CRM8 EndpointsCRM / CrmMessage

Add a new CustomerMessage for a company

POST/api/crm/messages/{companyId}

Path parameters

companyIdrequiredstring

Responses

200Add a new CustomerMessage for a companyCustomerMessage

Show fields (9)

idinteger
Primary key of the customer message. Internal ID.
usernamestring
User name of the author.
displaynamestring
Name shown for the author.
userpositionstring
Position of the author shown with the message.
profile_picture_urlstring
URL of the profile picture of the author.
textstring
Text of the message.
attachmentsarray<Attachment10>
Attachments of the message.
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.

Request

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

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

fetch('https://your-instance.iw-erp.de/api/crm/messages/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/crm/messages/42"

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

response = requests.post(url, 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/crm/messages/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.Post,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/crm/messages/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/crm/messages/42")
  .post(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/crm/messages/42"

	req, _ := http.NewRequest("POST", 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/crm_message_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/customer_message.dart';

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

final result = await CrmMessageController.post('42', CustomerMessage.fromJson({}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "username": "lena.hartmann@example.org",
  "profile_picture_url": "https://vynst.de",
  "text": "Text",
  "displayname": "string",
  "userposition": "string",
  "attachments": [
    {
      "id": 42,
      "ocr_from_name": "Beispiel",
      "ocr_from_email": "lena.hartmann@example.org",
      "ocr_from_phone": "+49 511 123456",
      "ocr_to_name": "Beispiel",
      "ocr_to_email": "lena.hartmann@example.org",
      "ocr_to_phone": "+49 511 123456",
      "filename": "string",
      "filesize": "string",
      "mimetype": "string"
    }
  ],
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

This method will get a single CustomerMessage Object with the given id

GET/api/crm/messages/{id}

Path parameters

idrequiredstring

Responses

200Returns a single CustomerMessageCustomerMessage

Show fields (9)

idinteger
Primary key of the customer message. Internal ID.
usernamestring
User name of the author.
displaynamestring
Name shown for the author.
userpositionstring
Position of the author shown with the message.
profile_picture_urlstring
URL of the profile picture of the author.
textstring
Text of the message.
attachmentsarray<Attachment10>
Attachments of the message.
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/crm/messages/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/crm/messages/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/crm/messages/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/crm/messages/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/crm/messages/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/crm/messages/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/crm/messages/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/crm_message_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 CrmMessageController.get('42');
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "username": "lena.hartmann@example.org",
  "profile_picture_url": "https://vynst.de",
  "text": "Text",
  "displayname": "string",
  "userposition": "string",
  "attachments": [
    {
      "id": 42,
      "ocr_from_name": "Beispiel",
      "ocr_from_email": "lena.hartmann@example.org",
      "ocr_from_phone": "+49 511 123456",
      "ocr_to_name": "Beispiel",
      "ocr_to_email": "lena.hartmann@example.org",
      "ocr_to_phone": "+49 511 123456",
      "filename": "string",
      "filesize": "string",
      "mimetype": "string"
    }
  ],
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

This method will update a CustomerMessage Object

PUT/api/crm/messages/{id}

Path parameters

idrequiredstring

Responses

200Update a CustomerMessageCustomerMessage

Show fields (9)

idinteger
Primary key of the customer message. Internal ID.
usernamestring
User name of the author.
displaynamestring
Name shown for the author.
userpositionstring
Position of the author shown with the message.
profile_picture_urlstring
URL of the profile picture of the author.
textstring
Text of the message.
attachmentsarray<Attachment10>
Attachments of the message.
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.

Request

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

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

fetch('https://your-instance.iw-erp.de/api/crm/messages/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/crm/messages/42"

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

response = requests.put(url, 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/crm/messages/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.Put,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/crm/messages/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/crm/messages/42")
  .put(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/crm/messages/42"

	req, _ := http.NewRequest("PUT", 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/crm_message_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/customer_message.dart';

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

final result = await CrmMessageController.put(CustomerMessage.fromJson({}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "username": "lena.hartmann@example.org",
  "profile_picture_url": "https://vynst.de",
  "text": "Text",
  "displayname": "string",
  "userposition": "string",
  "attachments": [
    {
      "id": 42,
      "ocr_from_name": "Beispiel",
      "ocr_from_email": "lena.hartmann@example.org",
      "ocr_from_phone": "+49 511 123456",
      "ocr_to_name": "Beispiel",
      "ocr_to_email": "lena.hartmann@example.org",
      "ocr_to_phone": "+49 511 123456",
      "filename": "string",
      "filesize": "string",
      "mimetype": "string"
    }
  ],
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

This method will update a CustomerMessage Object

PATCH/api/crm/messages/{id}

Path parameters

idrequiredstring

Responses

200Update a CustomerMessageCustomerMessage

Show fields (9)

idinteger
Primary key of the customer message. Internal ID.
usernamestring
User name of the author.
displaynamestring
Name shown for the author.
userpositionstring
Position of the author shown with the message.
profile_picture_urlstring
URL of the profile picture of the author.
textstring
Text of the message.
attachmentsarray<Attachment10>
Attachments of the message.
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.

Request

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

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

fetch('https://your-instance.iw-erp.de/api/crm/messages/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/crm/messages/42"

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

response = requests.patch(url, 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/crm/messages/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.Patch,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/crm/messages/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/crm/messages/42")
  .patch(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/crm/messages/42"

	req, _ := http.NewRequest("PATCH", 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 package:http (no controller in the iw_erp_api package)

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

final response = await http.patch(
  Uri.parse('https://your-instance.iw-erp.de/api/crm/messages/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>'},
);
print(response.body);

Response 200 application/json

{
  "id": 42,
  "username": "lena.hartmann@example.org",
  "profile_picture_url": "https://vynst.de",
  "text": "Text",
  "displayname": "string",
  "userposition": "string",
  "attachments": [
    {
      "id": 42,
      "ocr_from_name": "Beispiel",
      "ocr_from_email": "lena.hartmann@example.org",
      "ocr_from_phone": "+49 511 123456",
      "ocr_to_name": "Beispiel",
      "ocr_to_email": "lena.hartmann@example.org",
      "ocr_to_phone": "+49 511 123456",
      "filename": "string",
      "filesize": "string",
      "mimetype": "string"
    }
  ],
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

This method will get all CustomerMessage Objects

GET/api/crm/messages/{companyId}/{timestamp}/new

Path parameters

`companyId`requiredstring
`timestamp`requiredstring

Responses

default

Request

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

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

fetch('https://your-instance.iw-erp.de/api/crm/messages/42/42/new', 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/crm/messages/42/42/new"

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/crm/messages/42/42/new', [
  '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/crm/messages/42/42/new"),
  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/crm/messages/42/42/new")
  .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/crm/messages/42/42/new"

	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/crm_message_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 CrmMessageController.getNewMessages('42', 42);
if (result.success) {
  print(result.data);
}

This method will get CustomerMessages from given timestamp on (limit 500) and mapped by their date

GET/api/crm/messages/{companyId}/{timestamp}/daily

Path parameters

`companyId`requiredstring
`timestamp`requiredstring

Responses

default

Request

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

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

fetch('https://your-instance.iw-erp.de/api/crm/messages/42/42/daily', 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/crm/messages/42/42/daily"

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/crm/messages/42/42/daily', [
  '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/crm/messages/42/42/daily"),
  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/crm/messages/42/42/daily")
  .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/crm/messages/42/42/daily"

	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/crm_message_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 CrmMessageController.getDailyMessages('42', 42);
if (result.success) {
  print(result.data);
}

Add an Attachment to a Message

POST/api/crm/messages/{id}/adds/attachments

Path parameters

idrequiredstring

Responses

200Add an Attachment to a CustomerMessageCustomerMessage

Show fields (9)

idinteger
Primary key of the customer message. Internal ID.
usernamestring
User name of the author.
displaynamestring
Name shown for the author.
userpositionstring
Position of the author shown with the message.
profile_picture_urlstring
URL of the profile picture of the author.
textstring
Text of the message.
attachmentsarray<Attachment10>
Attachments of the message.
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/crm/messages/42/adds/attachments \
  --header 'x-iw-jwt-token: <TOKEN>'

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

fetch('https://your-instance.iw-erp.de/api/crm/messages/42/adds/attachments', 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/crm/messages/42/adds/attachments"

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

response = requests.post(url, 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/crm/messages/42/adds/attachments', [
  'headers' => [
    '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/crm/messages/42/adds/attachments"),
  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/crm/messages/42/adds/attachments")
  .post(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/crm/messages/42/adds/attachments"

	req, _ := http.NewRequest("POST", 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/crm_message_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/attachment.dart';
import 'package:iw_erp_api/model/customer_message.dart';

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

final result = await CrmMessageController.addAttachment(CustomerMessage.fromJson({}), Attachment.fromJson({}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "username": "lena.hartmann@example.org",
  "profile_picture_url": "https://vynst.de",
  "text": "Text",
  "displayname": "string",
  "userposition": "string",
  "attachments": [
    {
      "id": 42,
      "ocr_from_name": "Beispiel",
      "ocr_from_email": "lena.hartmann@example.org",
      "ocr_from_phone": "+49 511 123456",
      "ocr_to_name": "Beispiel",
      "ocr_to_email": "lena.hartmann@example.org",
      "ocr_to_phone": "+49 511 123456",
      "filename": "string",
      "filesize": "string",
      "mimetype": "string"
    }
  ],
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}

Remove an Attachment from CustomerMessage

POST/api/crm/messages/{id}/deletes/attachments

Path parameters

idrequiredstring

Responses

200Remove an Attachment from a CustomerMessageCustomerMessage

Show fields (9)

idinteger
Primary key of the customer message. Internal ID.
usernamestring
User name of the author.
displaynamestring
Name shown for the author.
userpositionstring
Position of the author shown with the message.
profile_picture_urlstring
URL of the profile picture of the author.
textstring
Text of the message.
attachmentsarray<Attachment10>
Attachments of the message.
Show fields (25)
- idinteger
  Primary key of the attachment. Internal ID.
- filenamestring
  Original file name.
- filesizestring
  Size of the file in bytes.
- mimetypestring
  MIME type of the file.
- createdbyusernamestring
  Name of the user who uploaded the file, as text.
- createdstring (date-time)
  Point in time the attachment was created.
- googleidstring
  ID of the file in Google Drive.
- scopestring
  Scope that controls who can see the attachment.
- ocr_document_typestring
  Document type recognized by OCR.
- ocr_from_namestring
  Sender name recognized by OCR.
- ocr_from_companystring
  Sender company recognized by OCR.
- ocr_from_addressstring
  Sender address recognized by OCR.
- ocr_from_emailstring
  Sender e-mail address recognized by OCR.
- ocr_from_phonestring
  Sender phone number recognized by OCR.
- ocr_to_namestring
  Recipient name recognized by OCR.
- ocr_to_companystring
  Recipient company recognized by OCR.
- ocr_to_addressstring
  Recipient address recognized by OCR.
- ocr_to_emailstring
  Recipient e-mail address recognized by OCR.
- ocr_to_phonestring
  Recipient phone number recognized by OCR.
- ocr_summarystring
  Summary of the document created by OCR.
- ocr_statusstring
  OCR processing status: null=not processed, pending, processing, done, error
- ocr_errorstring
  Reason of the last failed or incomplete OCR run, null when it went through
- ocr_processed_atstring (date-time)
  Point in time OCR processing finished.
- virus_checkedboolean
  1 once the virus scan has passed for this file. The scan runs in the background (AttachmentVirusScanCommand), so a freshly uploaded file starts at 0 and stays there until it was really checked. An infected file never reaches 1 - it is deleted instead. UIs use this to decide whether a file may be handed to a user, so it must stay false until proven otherwise.
- virus_checked_atstring (date-time)
  When the virus scan passed. Null while the file is still waiting.
createdstring (date-time)
Point in time the entity was created.
updatedstring (date-time)
Point in time the entity was last updated.

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/crm/messages/42/deletes/attachments \
  --header 'x-iw-jwt-token: <TOKEN>'

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

fetch('https://your-instance.iw-erp.de/api/crm/messages/42/deletes/attachments', 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/crm/messages/42/deletes/attachments"

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

response = requests.post(url, 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/crm/messages/42/deletes/attachments', [
  'headers' => [
    '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/crm/messages/42/deletes/attachments"),
  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/crm/messages/42/deletes/attachments")
  .post(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/crm/messages/42/deletes/attachments"

	req, _ := http.NewRequest("POST", 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/crm_message_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/attachment.dart';
import 'package:iw_erp_api/model/customer_message.dart';

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

final result = await CrmMessageController.deleteAttachment(CustomerMessage.fromJson({}), Attachment.fromJson({}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "username": "lena.hartmann@example.org",
  "profile_picture_url": "https://vynst.de",
  "text": "Text",
  "displayname": "string",
  "userposition": "string",
  "attachments": [
    {
      "id": 42,
      "ocr_from_name": "Beispiel",
      "ocr_from_email": "lena.hartmann@example.org",
      "ocr_from_phone": "+49 511 123456",
      "ocr_to_name": "Beispiel",
      "ocr_to_email": "lena.hartmann@example.org",
      "ocr_to_phone": "+49 511 123456",
      "filename": "string",
      "filesize": "string",
      "mimetype": "string"
    }
  ],
  "created": "2026-10-15T09:30:00+02:00",
  "updated": "2026-10-15T09:30:00+02:00"
}