ContactAdd

With this function a new contact data record can be created. The return value is the ID of the new data record. If an identical contact data record already exists, its ID is returned.

Request

Field

Type

RegExp

Null?

Description

auth

AuthData

no

Authentication data

type

integer

yes

Type (0 = person, 1 = company/organization)

salutation

integer

^[012]$

yes

Saluation (0 = Mr, 1 = Mrs, 2 = none)

title

string

^.{1,50}$

yes

Title (e.g. Dr.)

firstname

string

^.{1,128}$

no

First name

lastname

string

^.{1,128}$

no

Last name

company

string

^.{1,128}$

yes

Company

address1

string

^.{1,128}$

yes

Address

address2

string

^.{1,128}$

yes

Address (continued)

zipcode

string

^.{1,10}$

yes

ZIP code

city

string

^.{1,64}$

yes

City

country

string

^\w\w$

no

Country (ISO 3166-1 encoded)

phone

string

^.{1,30}$

yes

Phone number

fax

string

^.{1,30}$

yes

Fax number

mobile

string

^.{1,30}$

yes

Mobile number

email

string

EMAIL

yes

E-Mail address

website

string

^.{1,128}$

yes

Website

permissive

integer

^[01]?$

yes

If 1, the contact data will not be checked syntactically and possibly be created multiple times (no detection of duplicates). The fields type, salutation, firstname, lastname and country are required though (since version 2.4.0, default 0)

Response

Field

Type

Null?

Description

id

string

no

Data record ID

error

string

yes

If permissive=1 was set, this field contains a possible error message from the syntax check

The data record ID is customer-specific encrypted.


Last updated on Apr 13, 2020.
next: ContactEdit
previous: SOAP API