Zum Inhalt springen
Developer

Unified Tags

CRM / Vereinheitlichte Tags

CRM6 EndpunkteCRM / Unified Tags

Liefert eine Liste der einheitlichen Tags.

GET/api/crm/unified_tag

Query-Parameter

idintegerErfordert Zugriffsrecht: PUBLIC, PUBLIC_LIST, SCOPE
namestringErfordert Zugriffsrecht: PUBLIC, PUBLIC_LIST, SCOPE
deletedbooleanDiese Eigenschaft markiert eine Entität als gelöscht / archiviert | Benötigtes Zugriffsrecht: SCOPE | Standardwert: false
searchStringstringText, nach dem in der Liste gesucht wird
orderFieldNamestringName des Bestellfelds
orderFieldSortstringSortiermodusErlaubt: DESCASC
pageintegerSeite der Liste
pageSizeintegerAnzahl der Einträge je Seite
withMaxPageNumberstringgibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert eine Liste der einheitlichen Tags.array<UnifiedTag>

Felder anzeigen (4)
  • idinteger

    Primärschlüssel des einheitlichen Tags. Interne ID.

  • parentsarray<UnifiedTag>
  • namestring

    Name der Einheit.

  • deletedboolean

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

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/crm/unified_tag \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "name": "Beispiel",
    "deleted": true
  }
]

Einheitlichen Tag neu anlegen

POST/api/crm/unified_tag

Request-Body application/json

  • dataUnifiedTag2
    Felder anzeigen (2)
    • namestring

      Name der Einheit.

    • deletedboolean

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

Antworten

200Einheitlichen Tag neu anlegenUnifiedTag

Felder anzeigen (4)
  • idinteger

    Primärschlüssel des einheitlichen Tags. Interne ID.

  • parentsarray<UnifiedTag>
  • namestring

    Name der Einheit.

  • deletedboolean

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

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/crm/unified_tag \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "deleted": true
}

Gibt ein einzelnes einheitliches Tag mit der angegebenen ID zurück.

GET/api/crm/unified_tag/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Gibt ein einzelnes einheitliches Tag mit der angegebenen ID zurück.UnifiedTag

Felder anzeigen (4)
  • idinteger

    Primärschlüssel des einheitlichen Tags. Interne ID.

  • parentsarray<UnifiedTag>
  • namestring

    Name der Einheit.

  • deletedboolean

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

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/crm/unified_tag/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "deleted": true
}

Vereinheitlichten Tag mit der angegebenen ID einzeln aktualisieren

PUT/api/crm/unified_tag/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

  • dataUnifiedTag2
    Felder anzeigen (2)
    • namestring

      Name der Einheit.

    • deletedboolean

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

Antworten

200Vereinheitlichten Tag mit der angegebenen ID einzeln aktualisierenUnifiedTag

Felder anzeigen (4)
  • idinteger

    Primärschlüssel des einheitlichen Tags. Interne ID.

  • parentsarray<UnifiedTag>
  • namestring

    Name der Einheit.

  • deletedboolean

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

Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/crm/unified_tag/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "deleted": true
}

Vereinheitlichten Tag mit der angegebenen ID einzeln aktualisieren

PATCH/api/crm/unified_tag/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

  • dataUnifiedTag2
    Felder anzeigen (2)
    • namestring

      Name der Einheit.

    • deletedboolean

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

Antworten

200Vereinheitlichten Tag mit der angegebenen ID einzeln aktualisierenUnifiedTag

Felder anzeigen (4)
  • idinteger

    Primärschlüssel des einheitlichen Tags. Interne ID.

  • parentsarray<UnifiedTag>
  • namestring

    Name der Einheit.

  • deletedboolean

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

Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/crm/unified_tag/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "deleted": true
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "deleted": true
}

Liefert eine Liste der öffentlichen einheitlichen Tags.

GET/api/crm/public/tag/unified

Query-Parameter

idintegerErfordert Zugriffsrecht: PUBLIC, PUBLIC_LIST, SCOPE
namestringErfordert Zugriffsrecht: PUBLIC, PUBLIC_LIST, SCOPE
deletedbooleanDiese Eigenschaft markiert eine Entität als gelöscht / archiviert | Benötigtes Zugriffsrecht: SCOPE | Standardwert: false
searchStringstringText, nach dem in der Liste gesucht wird
orderFieldNamestringName des Bestellfelds
orderFieldSortstringSortiermodusErlaubt: DESCASC
pageintegerSeite der Liste
pageSizeintegerAnzahl der Einträge je Seite
withMaxPageNumberstringgibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert eine Liste der öffentlichen einheitlichen Tags.array<UnifiedTag3>

Felder anzeigen (4)
  • idinteger

    Primärschlüssel des einheitlichen Tags. Interne ID.

  • parentsarray<UnifiedTag3>
  • namestring

    Name der Einheit.

  • deletedboolean

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

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/crm/public/tag/unified \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "name": "Beispiel",
    "deleted": true
  }
]