Sign in

v1

latestOpenAPI 3.0.02026-07-2455104.8 MB
Customer

🔒 Update contact person V3

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: customer:update.

Update an existing contact person for a customer.

patch/api/v3/customers/{customerId}/contactPersons/{contactPersonId}

Path parameters

customerIdstring required
contactPersonIdstring required

Request body

type'mrs' | 'mr' | 'company' | 'other'

Type of contact person

namestring

Name of contact person

titlestring

Title of contact person

salutationstring

Salutation of contact person

departmentstring

Department of contact person

subDepartmentstring

Sub-Department of contact person

streetstring

Street of contact person address

addressSupplementstring

Address supplement of contact person address

zipCodestring

Zip code of contact person address

citystring

City of contact person address

statestring

State of contact person address

countrystring

Country of contact person address (ISO-3166-1 alpha-2)

phonestring

Phone number of contact person

mobilestring

Mobile number of contact person

faxstring

Fax number of contact person

emailstring email

Email address of contact person

Example request

{
  "type": "mr",
  "name": "Müller",
  "title": "Dr.",
  "salutation": "Sehr geehrter Herr Dr. Müller",
  "department": "Einkauf",
  "subDepartment": "Strategische Beschaffung",
  "street": "Hauptstraße 15",
  "addressSupplement": "Gebäude B, 1. Etage",
  "zipCode": "40210",
  "city": "Düsseldorf",
  "state": "NW",
  "country": "DE",
  "phone": "+49 211 555-101",
  "mobile": "+49 151 7777-101",
  "fax": "+49 211 555-109",
  "email": "k.mueller@beispiel-gmbh.de",
  "contactPersonDetails": {
    "position": "Purchasing Manager",
    "birthday": "1985-03-15",
    "language": "de",
    "allowMarketingEmails": true,
    "internalNote": "Prefers email communication",
    "remarks": "Available Mon-Fri 9-5"
  },
  "groups": [
    {
      "id": "1"
    },
    {
      "id": "7"
    }
  ]
}

Response

Update an existing contact person for a customer.

Example response

{
  "data": {
    "id": "17",
    "type": "mr",
    "name": "Alice Smith",
    "title": "Ms.",
    "salutation": "Dear Alice,",
    "department": "Sales",
    "subDepartment": "Customer Service",
    "street": "123 Main St",
    "addressSupplement": "Suite 100",
    "zipCode": "12345",
    "city": "Springfield",
    "country": "US",
    "state": "CA",
    "phone": "+1-234-567-8900",
    "mobile": "+1-800-567-8900",
    "fax": "+1-234-567-8901",
    "email": "alice@example.com",
    "contactPersonDetails": {
      "position": "Head of Controlling",
      "birthday": "1978-04-12",
      "language": "DE",
      "allowMarketingEmails": false,
      "internalNote": "Key decision‑maker for raw‑material contracts; prefers email after 17:00 CET.",
      "remarks": "Speaks fluent English, French and Mandarin. Holds a PhD in Economics."
    },
    "groups": [
      {
        "id": "1"
      }
    ],
    "createdAt": "2025-03-15T09:27:00+01:00",
    "updatedAt": "2025-10-20T14:45:12+01:00"
  }
}