Skip to main content
POST
Add a contact to a client

Authorizations

Authorization
string
header
required

Swagger / Postman only: Client ID as username, Client secret as password. In Postman, set this once on the collection (Authorization → Basic Auth) so all requests inherit. For production server-to-server code, prefer X-OM-Auth-ID and X-OM-Auth-Key headers.

Path Parameters

entityKey
string<uuid>
required

Client entity key (identifier).

Body

contactID
integer<int64> | null
contactName
string | null
Maximum string length: 255
contactSurname
string | null
Maximum string length: 255
salutation
string | null
Maximum string length: 100
addressee
string | null
Maximum string length: 255
email
string | null
Maximum string length: 100
mobile
string | null
Maximum string length: 45
telephone
string | null
Maximum string length: 45
position
string | null
Maximum string length: 100
isPrimary
boolean

Response

Created

entityContactID
integer<int64>
contactID
integer<int64>
matchedExistingContact
boolean