v1

latestOpenAPI 3.0.02026-07-2455104.8 MB

Customer - Contact Person

Update contact person

Updates new contact person for given customer.

patch/api/v1/customers/{customerId}/contactPerson/{contactPersonId}

Path parameters

customerIdstring required

Resource identifier.

Example:17

The customer's identifier.

contactPersonIdinteger required

Contact Person ID

Request body

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

Type of contact used later for salutations

namestring

Full name of the contact person

titlestring nullable

Additional information used for salutations

birthdaystring date nullable

birthdayShowInCalendarboolean

Decides wether or not to show in birthday calendar

sendBirthdayCardboolean

Decides wether or not to send birthday card via serial letter module

marketingBanboolean

Decides wether or not to send serial letters to this contact

departmentstring nullable

Department of contact if necessary and available

subDepartmentstring nullable

Sub-Department of contact if necessary and available

positionstring nullable

Position or responsibility

languagestring nullable

Two-letter ISO 639-1 code (uppercase or lowercase allowed).

groupsstring[]

List of groups this contact person is belong to

commentstring nullable

Internal comment for this contact

othersstring nullable

Every other information you deem relevant

Example request

{
  "type": "mr",
  "name": "Firstname Surname",
  "title": "Prof. Dr.",
  "birthday": "2001-01-14",
  "birthdayShowInCalendar": true,
  "sendBirthdayCard": true,
  "marketingBan": true,
  "department": "HR department",
  "subDepartment": "Sub department",
  "language": "DE",
  "address": {
    "street": "2176 example street",
    "additionalStreet": "6th floor",
    "zip": "12345",
    "city": "city",
    "state": "Ohio",
    "country": "DE"
  },
  "contact": {
    "phone": "+49 330 12345667",
    "fax": "+49 330 7654321",
    "mobile": "+49 172 7654321",
    "salutation": "Dear Dr. Smith, Friend and Supporter",
    "email": "contact-person@address-location.tld"
  },
  "groups": [
    "17",
    "22"
  ],
  "comment": "This is a internal comment"
}

Response

Operation completed successfully, no response body