CRMTicketComment

Tickets and projects7 EndpointsCRM / CRMTicketComment

This method will get all TicketComments Objects for a certain ticket

GET/api/crm/ticket/comments/{ticketId}

Path parameters

ticketIdrequiredstring

Responses

200Returns a list of TicketComment objects for a Ticketarray<CustomerTicketComment>

Show fields (12)

idinteger
Primary key of the ticket comment. Internal ID.
createdbyusernamestring
Name of the user who wrote the comment, as text.
created_by_userUser
User who wrote the comment.
Show fields (11)
- idinteger
  Primary key of the user. Internal ID of the login user.
- namestring
  Display name of the user. Shown in the UI and in audit entries.
- usernamestring
  Login name of the user. Must be unique across all users.
- emailstring
  E-mail address of the user. Used for login notifications, password resets and as a login alias.
- user_access_groupUserAccessGroup3
  User access group of the user. Defines the rights of the user for all scopes.
- positioningeneralstring
  Free text describing the position or role of the user.
- crm_personCRMPerson10
  CRM person linked to this login user. Connects the login account with the person record.
- profile_picture_urlstring
  URL of the profile picture of the user.
- archivedboolean
  Marks the user as archived. Archived users are kept for history and are not active.
- require2faboolean
  Two-factor authentication is required for this user.
- search_stringstring
  Text that the entity can be searched by.
displaynamestring
Name shown for the author of the comment.
userpositionstring
Position of the author shown with the comment.
profile_picture_urlstring
URL of the profile picture of the author.
jiraidstring
ID of the linked Jira comment.
inportalboolean
Whether the comment is visible in the customer portal.
is_draftboolean
Whether the comment is an unsent draft.
attachmentsarray<Attachment10>
Attachments of the comment.
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/ticket/comments/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/ticket/comments/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/ticket/comments/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/ticket/comments/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/ticket/comments/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/ticket/comments/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/ticket/comments/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_ticket_comment_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/customer_ticket.dart';

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

final result = await CrmTicketCommentController.getAll(CustomerTicket.fromJson({}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

[
  {
    "id": 42,
    "profile_picture_url": "https://vynst.de",
    "createdbyusername": "string",
    "created_by_user": {
      "id": 42,
      "name": "Beispiel",
      "username": "lena.hartmann@example.org",
      "email": "lena.hartmann@example.org",
      "profile_picture_url": "https://vynst.de",
      "positioningeneral": "string",
      "archived": true,
      "require2fa": true,
      "search_string": "string"
    },
    "displayname": "string",
    "userposition": "string",
    "jiraid": "string",
    "inportal": true,
    "is_draft": true,
    "created": "2026-10-15T09:30:00+02:00"
  }
]

Add a new TicketComment

POST/api/crm/ticket/comments/{ticketId}

Path parameters

ticketIdrequiredstring

Request body application/json

dataCustomerTicketComment2

Responses

200Add a new TicketCommentCustomerTicketComment

Show fields (12)

idinteger
Primary key of the ticket comment. Internal ID.
createdbyusernamestring
Name of the user who wrote the comment, as text.
created_by_userUser
User who wrote the comment.
Show fields (11)
- idinteger
  Primary key of the user. Internal ID of the login user.
- namestring
  Display name of the user. Shown in the UI and in audit entries.
- usernamestring
  Login name of the user. Must be unique across all users.
- emailstring
  E-mail address of the user. Used for login notifications, password resets and as a login alias.
- user_access_groupUserAccessGroup3
  User access group of the user. Defines the rights of the user for all scopes.
- positioningeneralstring
  Free text describing the position or role of the user.
- crm_personCRMPerson10
  CRM person linked to this login user. Connects the login account with the person record.
- profile_picture_urlstring
  URL of the profile picture of the user.
- archivedboolean
  Marks the user as archived. Archived users are kept for history and are not active.
- require2faboolean
  Two-factor authentication is required for this user.
- search_stringstring
  Text that the entity can be searched by.
displaynamestring
Name shown for the author of the comment.
userpositionstring
Position of the author shown with the comment.
profile_picture_urlstring
URL of the profile picture of the author.
jiraidstring
ID of the linked Jira comment.
inportalboolean
Whether the comment is visible in the customer portal.
is_draftboolean
Whether the comment is an unsent draft.
attachmentsarray<Attachment10>
Attachments of the comment.
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/ticket/comments/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '{}'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({})
};

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

payload = {}
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/crm/ticket/comments/42', [
  'body' => '{}',
  '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/crm/ticket/comments/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{}")
  {
    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, "{}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/crm/ticket/comments/42")
  .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/crm/ticket/comments/42"

	payload := strings.NewReader("{}")

	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/crm_ticket_comment_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/customer_ticket.dart';
import 'package:iw_erp_api/model/customer_ticket_comment.dart';

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

final result = await CrmTicketCommentController.post(CustomerTicket.fromJson({}), CustomerTicketComment.fromJson({}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "profile_picture_url": "https://vynst.de",
  "createdbyusername": "string",
  "created_by_user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "displayname": "string",
  "userposition": "string",
  "jiraid": "string",
  "inportal": true,
  "is_draft": true,
  "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"
    }
  ]
}

This method will update a CustomerTicketComment Object with the given id

PUT/api/crm/ticket/comments/{id}

Path parameters

idrequiredstring

Request body application/json

dataCustomerTicketComment2

Responses

200Update a TicketCommentCustomerTicketComment

Show fields (12)

idinteger
Primary key of the ticket comment. Internal ID.
createdbyusernamestring
Name of the user who wrote the comment, as text.
created_by_userUser
User who wrote the comment.
Show fields (11)
- idinteger
  Primary key of the user. Internal ID of the login user.
- namestring
  Display name of the user. Shown in the UI and in audit entries.
- usernamestring
  Login name of the user. Must be unique across all users.
- emailstring
  E-mail address of the user. Used for login notifications, password resets and as a login alias.
- user_access_groupUserAccessGroup3
  User access group of the user. Defines the rights of the user for all scopes.
- positioningeneralstring
  Free text describing the position or role of the user.
- crm_personCRMPerson10
  CRM person linked to this login user. Connects the login account with the person record.
- profile_picture_urlstring
  URL of the profile picture of the user.
- archivedboolean
  Marks the user as archived. Archived users are kept for history and are not active.
- require2faboolean
  Two-factor authentication is required for this user.
- search_stringstring
  Text that the entity can be searched by.
displaynamestring
Name shown for the author of the comment.
userpositionstring
Position of the author shown with the comment.
profile_picture_urlstring
URL of the profile picture of the author.
jiraidstring
ID of the linked Jira comment.
inportalboolean
Whether the comment is visible in the customer portal.
is_draftboolean
Whether the comment is an unsent draft.
attachmentsarray<Attachment10>
Attachments of the comment.
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/ticket/comments/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '{}'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({})
};

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

payload = {}
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/crm/ticket/comments/42', [
  'body' => '{}',
  '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/crm/ticket/comments/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{}")
  {
    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, "{}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/crm/ticket/comments/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/crm/ticket/comments/42"

	payload := strings.NewReader("{}")

	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/crm_ticket_comment_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/customer_ticket_comment.dart';

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

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

Response 200 application/json

{
  "id": 42,
  "profile_picture_url": "https://vynst.de",
  "createdbyusername": "string",
  "created_by_user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "displayname": "string",
  "userposition": "string",
  "jiraid": "string",
  "inportal": true,
  "is_draft": true,
  "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"
    }
  ]
}

This method will update a CustomerTicketComment Object with the given id

PATCH/api/crm/ticket/comments/{id}

Path parameters

idrequiredstring

Request body application/json

dataCustomerTicketComment2

Responses

200Update a TicketCommentCustomerTicketComment

Show fields (12)

idinteger
Primary key of the ticket comment. Internal ID.
createdbyusernamestring
Name of the user who wrote the comment, as text.
created_by_userUser
User who wrote the comment.
Show fields (11)
- idinteger
  Primary key of the user. Internal ID of the login user.
- namestring
  Display name of the user. Shown in the UI and in audit entries.
- usernamestring
  Login name of the user. Must be unique across all users.
- emailstring
  E-mail address of the user. Used for login notifications, password resets and as a login alias.
- user_access_groupUserAccessGroup3
  User access group of the user. Defines the rights of the user for all scopes.
- positioningeneralstring
  Free text describing the position or role of the user.
- crm_personCRMPerson10
  CRM person linked to this login user. Connects the login account with the person record.
- profile_picture_urlstring
  URL of the profile picture of the user.
- archivedboolean
  Marks the user as archived. Archived users are kept for history and are not active.
- require2faboolean
  Two-factor authentication is required for this user.
- search_stringstring
  Text that the entity can be searched by.
displaynamestring
Name shown for the author of the comment.
userpositionstring
Position of the author shown with the comment.
profile_picture_urlstring
URL of the profile picture of the author.
jiraidstring
ID of the linked Jira comment.
inportalboolean
Whether the comment is visible in the customer portal.
is_draftboolean
Whether the comment is an unsent draft.
attachmentsarray<Attachment10>
Attachments of the comment.
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/ticket/comments/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '{}'

const options = {
  method: 'PATCH',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({})
};

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

payload = {}
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/crm/ticket/comments/42', [
  'body' => '{}',
  '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/crm/ticket/comments/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{}")
  {
    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, "{}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/crm/ticket/comments/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/crm/ticket/comments/42"

	payload := strings.NewReader("{}")

	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/crm/ticket/comments/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: jsonEncode({}),
);
print(response.body);

Response 200 application/json

{
  "id": 42,
  "profile_picture_url": "https://vynst.de",
  "createdbyusername": "string",
  "created_by_user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "displayname": "string",
  "userposition": "string",
  "jiraid": "string",
  "inportal": true,
  "is_draft": true,
  "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"
    }
  ]
}

This method will remove a CustomerTicketComment Object with the given id

DELETE/api/crm/ticket/comments/{id}

Path parameters

idrequiredstring

Responses

200Delete a TicketCommentCustomerTicketComment

Show fields (12)

idinteger
Primary key of the ticket comment. Internal ID.
createdbyusernamestring
Name of the user who wrote the comment, as text.
created_by_userUser
User who wrote the comment.
Show fields (11)
- idinteger
  Primary key of the user. Internal ID of the login user.
- namestring
  Display name of the user. Shown in the UI and in audit entries.
- usernamestring
  Login name of the user. Must be unique across all users.
- emailstring
  E-mail address of the user. Used for login notifications, password resets and as a login alias.
- user_access_groupUserAccessGroup3
  User access group of the user. Defines the rights of the user for all scopes.
- positioningeneralstring
  Free text describing the position or role of the user.
- crm_personCRMPerson10
  CRM person linked to this login user. Connects the login account with the person record.
- profile_picture_urlstring
  URL of the profile picture of the user.
- archivedboolean
  Marks the user as archived. Archived users are kept for history and are not active.
- require2faboolean
  Two-factor authentication is required for this user.
- search_stringstring
  Text that the entity can be searched by.
displaynamestring
Name shown for the author of the comment.
userpositionstring
Position of the author shown with the comment.
profile_picture_urlstring
URL of the profile picture of the author.
jiraidstring
ID of the linked Jira comment.
inportalboolean
Whether the comment is visible in the customer portal.
is_draftboolean
Whether the comment is an unsent draft.
attachmentsarray<Attachment10>
Attachments of the comment.
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 DELETE \
  --url https://your-instance.iw-erp.de/api/crm/ticket/comments/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/crm/ticket/comments/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/ticket/comments/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/crm/ticket/comments/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/crm/ticket/comments/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/ticket/comments/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/crm/ticket/comments/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/crm_ticket_comment_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/customer_ticket_comment.dart';

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

final result = await CrmTicketCommentController.delete(CustomerTicketComment.fromJson({}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "profile_picture_url": "https://vynst.de",
  "createdbyusername": "string",
  "created_by_user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "displayname": "string",
  "userposition": "string",
  "jiraid": "string",
  "inportal": true,
  "is_draft": true,
  "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"
    }
  ]
}

Add a Attachment to a Ticket_Comment

POST/api/crm/ticket/comments/{id}/adds/attachments

Path parameters

idrequiredstring

Responses

200Add an Attachment to a TicketCommentCustomerTicketComment

Show fields (12)

idinteger
Primary key of the ticket comment. Internal ID.
createdbyusernamestring
Name of the user who wrote the comment, as text.
created_by_userUser
User who wrote the comment.
Show fields (11)
- idinteger
  Primary key of the user. Internal ID of the login user.
- namestring
  Display name of the user. Shown in the UI and in audit entries.
- usernamestring
  Login name of the user. Must be unique across all users.
- emailstring
  E-mail address of the user. Used for login notifications, password resets and as a login alias.
- user_access_groupUserAccessGroup3
  User access group of the user. Defines the rights of the user for all scopes.
- positioningeneralstring
  Free text describing the position or role of the user.
- crm_personCRMPerson10
  CRM person linked to this login user. Connects the login account with the person record.
- profile_picture_urlstring
  URL of the profile picture of the user.
- archivedboolean
  Marks the user as archived. Archived users are kept for history and are not active.
- require2faboolean
  Two-factor authentication is required for this user.
- search_stringstring
  Text that the entity can be searched by.
displaynamestring
Name shown for the author of the comment.
userpositionstring
Position of the author shown with the comment.
profile_picture_urlstring
URL of the profile picture of the author.
jiraidstring
ID of the linked Jira comment.
inportalboolean
Whether the comment is visible in the customer portal.
is_draftboolean
Whether the comment is an unsent draft.
attachmentsarray<Attachment10>
Attachments of the comment.
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/ticket/comments/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/ticket/comments/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/ticket/comments/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/ticket/comments/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/ticket/comments/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/ticket/comments/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/ticket/comments/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_ticket_comment_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_ticket_comment.dart';

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

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

Response 200 application/json

{
  "id": 42,
  "profile_picture_url": "https://vynst.de",
  "createdbyusername": "string",
  "created_by_user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "displayname": "string",
  "userposition": "string",
  "jiraid": "string",
  "inportal": true,
  "is_draft": true,
  "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"
    }
  ]
}

Remove an Attachment from Ticket Comment

POST/api/crm/ticket/comments/{id}/deletes/attachments

Path parameters

idrequiredstring

Responses

200Remove an Attachment from TicketCommentCustomerTicketComment

Show fields (12)

idinteger
Primary key of the ticket comment. Internal ID.
createdbyusernamestring
Name of the user who wrote the comment, as text.
created_by_userUser
User who wrote the comment.
Show fields (11)
- idinteger
  Primary key of the user. Internal ID of the login user.
- namestring
  Display name of the user. Shown in the UI and in audit entries.
- usernamestring
  Login name of the user. Must be unique across all users.
- emailstring
  E-mail address of the user. Used for login notifications, password resets and as a login alias.
- user_access_groupUserAccessGroup3
  User access group of the user. Defines the rights of the user for all scopes.
- positioningeneralstring
  Free text describing the position or role of the user.
- crm_personCRMPerson10
  CRM person linked to this login user. Connects the login account with the person record.
- profile_picture_urlstring
  URL of the profile picture of the user.
- archivedboolean
  Marks the user as archived. Archived users are kept for history and are not active.
- require2faboolean
  Two-factor authentication is required for this user.
- search_stringstring
  Text that the entity can be searched by.
displaynamestring
Name shown for the author of the comment.
userpositionstring
Position of the author shown with the comment.
profile_picture_urlstring
URL of the profile picture of the author.
jiraidstring
ID of the linked Jira comment.
inportalboolean
Whether the comment is visible in the customer portal.
is_draftboolean
Whether the comment is an unsent draft.
attachmentsarray<Attachment10>
Attachments of the comment.
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/ticket/comments/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/ticket/comments/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/ticket/comments/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/ticket/comments/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/ticket/comments/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/ticket/comments/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/ticket/comments/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_ticket_comment_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_ticket_comment.dart';

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

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

Response 200 application/json

{
  "id": 42,
  "profile_picture_url": "https://vynst.de",
  "createdbyusername": "string",
  "created_by_user": {
    "id": 42,
    "name": "Beispiel",
    "username": "lena.hartmann@example.org",
    "email": "lena.hartmann@example.org",
    "profile_picture_url": "https://vynst.de",
    "positioningeneral": "string",
    "crm_person": {
      "id": 42,
      "first_name": "Lena",
      "last_name": "Hartmann",
      "title": "Beispiel",
      "language": "de",
      "support_description": "Text",
      "profile_picture_url": "https://vynst.de",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "archived": true,
    "require2fa": true,
    "search_string": "string"
  },
  "displayname": "string",
  "userposition": "string",
  "jiraid": "string",
  "inportal": true,
  "is_draft": true,
  "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"
    }
  ]
}