Ansprechpartner aktualisieren

Aktualisiert einen Ansprechpartner des angegebenen Kunden und liefert ihn mit geladenen Kategorien zurück.

Verfügbarkeit: Nur Vollversion — eine Clock-Instanz antwortet auf diesen Endpunkt mit 404.

PUT wird für diese Operation als Alias von PATCH akzeptiert.

Request

PATCH /api/v1/customers/{customer_number}/contacts/{id}

curl --request PATCH \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/customers/{customer_number}/contacts/{id}' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}' \
     --header 'Content-Type: application/json' \
     --data '{
       "salutation": "Frau",
       "first_name": "Erika",
       "last_name": "Mustermann",
       "email": "erika.mustermann@acme-corp.de",
       "phone": "+49 30 12345678",
       "fax": "+1-555-0124",
       "mobile": "+49 170 1234567",
       "primary": "prim",
       "department": "Einkauf",
       "job_title": "Leiterin Einkauf",
       "language": "de",
       "inactive": false,
       "title": "Dr.",
       "username": "max.mustermann",
       "password": "1234",
       "categories": [
         "string"
       ]
     }'

Pfad-Parameter

Name
customer_number
Type
string
Description
Die Kundennummer des Kunden
Name
id
Type
integer
Description
Die ID des Ansprechpartners

Request-Body

Name
salutation
Type
string, nullable
Description
Anrede des Ansprechpartners (z. B. Herr/Frau), wird in der Korrespondenz verwendet.
Name
first_name
Type
string
Description
Vorname des Ansprechpartners.
Name
last_name
Type
string
Description
Nachname des Ansprechpartners.
Name
email
Type
string (email), nullable
Description
E-Mail-Adresse des Ansprechpartners.
Name
phone
Type
string, nullable
Description
Telefonnummer des Ansprechpartners.
Name
fax
Type
string, nullable
Description
Faxnummer des Ansprechpartners.
Name
mobile
Type
string, nullable
Description
Mobilnummer des Ansprechpartners.
Name
primary
Type
string, nullable
Description
Ob dieser Ansprechpartner der primäre Ansprechpartner des Kunden werden soll.
Einer der Werte: "prim", "sec"
Name
department
Type
string, nullable
Description
Freitext-Abteilungsname für diesen Ansprechpartner — ohne Bezug zum Abteilungsmodul.
Name
job_title
Type
string, nullable
Description
Position des Ansprechpartners beim Kunden.
Name
language
Type
string, nullable
Description
Bevorzugte Sprache des Ansprechpartners, wird für übersetzte Inhalte verwendet.
Name
inactive
Type
boolean, nullable
Description
Ob dieser Ansprechpartner als inaktiv markiert werden soll.
Name
title
Type
string, nullable
Description
Akademischer Titel des Ansprechpartners (z. B. Dr.).
Name
username
Type
string, nullable
Description
Der Benutzername des Portal-Logins des Ansprechpartners, falls vorhanden.
Name
password
Type
string, nullable
Description
Das Passwort für den Portal-Login des Ansprechpartners, wenn ein Benutzername gesetzt ist.
Name
categories
Type
Liste von string, nullable
Description
Die IDs der Kategorien, die dem Ansprechpartner zugeordnet werden sollen.

Response

{
  "data": {
    "id": 1,
    "first_name": "Erika",
    "last_name": "Mustermann",
    "salutation": "Frau",
    "title": "Dr.",
    "phone": "+49 30 12345678",
    "mobile": "+49 170 1234567",
    "fax": "+1-555-0124",
    "email": "erika.mustermann@acme-corp.de",
    "primary": true,
    "job_title": "Leiterin Einkauf",
    "department": "Einkauf",
    "language": "de",
    "inactive": false,
    "categories": [
      {
        "name": "EU",
        "description": {
          "de": "string",
          "en": "string",
          "fr": "string",
          "es": "string",
          "pl": "string"
        },
        "type": {
          "id": "string",
          "name": "Mitarbeiter/in"
        }
      }
    ]
  }
}

Response-Felder

Name
id
Type
integer
Description
Eindeutige ID des Ansprechpartners.
Name
first_name
Type
string
Description
Vorname des Ansprechpartners.
Name
last_name
Type
string
Description
Nachname des Ansprechpartners.
Name
salutation
Type
string, nullable
Description
Anrede des Ansprechpartners (z. B. Herr/Frau), wird in der Korrespondenz verwendet.
Name
title
Type
string, nullable
Description
Akademischer Titel des Ansprechpartners (z. B. Dr.).
Name
phone
Type
string, nullable
Description
Telefonnummer des Ansprechpartners.
Name
mobile
Type
string, nullable
Description
Mobilnummer des Ansprechpartners.
Name
fax
Type
string, nullable
Description
Faxnummer des Ansprechpartners.
Name
email
Type
string, nullable
Description
E-Mail-Adresse des Ansprechpartners.
Name
primary
Type
boolean
Description
Ob dies der Hauptansprechpartner des Kunden ist.
Name
job_title
Type
string, nullable
Description
Position des Ansprechpartners beim Kunden.
Name
department
Type
string, nullable
Description
Freitext-Abteilungsname für diesen Ansprechpartner — ohne Bezug zum Abteilungsmodul.
Name
language
Type
string, nullable
Description
Bevorzugte Sprache des Ansprechpartners, wird für übersetzte Inhalte verwendet.
Name
inactive
Type
boolean
Description
Ob dieser Ansprechpartner inaktiv ist und nicht mehr aktiv verwendet wird.
Name
categories
Type
Liste von Category
Description
Die diesem Ansprechpartner zugeordneten Kategorien. Enthalten bei GET /customers/{customer}/contacts/{contact}, POST …/contacts und PUT …/contacts/{contact}; nicht enthalten beim Listen-Endpunkt GET /customers/{customer}/contacts.
Name
categories.name
Type
string
Description
Name der Kategorie, wird überall angezeigt, wo eine Entität damit gekennzeichnet ist.
Name
categories.description
Type
object
Description
Ausführlichere Erläuterung, wofür diese Kategorie verwendet werden soll.
Name
categories.type
Type
object
Description
Art der Entität, der diese Kategorie zugeordnet werden kann, z. B. Mitarbeiter, Projekt oder Kunde.

Aus der OpenAPI-Spezifikation erzeugt — Änderungen gehören in den Quellcode, nicht auf diese Seite.

GET Ansprechpartner abrufen DELETE Ansprechpartner löschen