Skip to main content
POST
/
api
/
v1
/
contacts
Create a new contact
curl --request POST \
  --url http://localhost:3000/api/v1/contacts \
  --header 'Content-Type: application/json' \
  --data '
{
  "companyName": "Complex GmbH",
  "firstName": "Claudia",
  "lastName": "Röthlisberger",
  "address": "Frutigenstrasse 24",
  "postCode": "3700 Spiez",
  "position": "Leiterin Bereich Metallurgie",
  "email": "test@test.com",
  "mobile": "079 111 22 33",
  "phone": "052 111 22 33",
  "website": "complex.swiss",
  "category": "clients",
  "note": "Kontakt durch Startup-Nights.",
  "vatNumber": "CHE 123.456.789 MWST"
}
'
{
  "contact": {
    "id": "68234731e6074232892d18c4",
    "companyName": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "address": "<string>",
    "postCode": "3700 Spiez",
    "position": "<string>",
    "email": "jsmith@example.com",
    "mobile": "<string>",
    "phone": "<string>",
    "website": "<string>",
    "category": "clients",
    "formOfAddress": "<string>",
    "note": "<string>",
    "vatNumber": "<string>",
    "country": "<string>",
    "secondaryAddressLine": "<string>"
  }
}

Body

application/json

A new contact requires at least one of the following fields to have a non-empty value:

  • Company name
  • First name
  • Last name

Represents a contact, such as a supplier, client, partner, lead, etc.

​
companyName
string

The company name associated with this contact.

For contacts which represent companies, this is used as the name of the contact.

Maximum string length: 48
​
firstName
string

The given name of this contact.

Maximum string length: 48
​
lastName
string

The surname of this contact.

Maximum string length: 48
​
address
string

The main address line of the contact.

Maximum string length: 48
​
postCode
string

The postal line text for this contact, including a ZIP code and place.

Example:

"3700 Spiez"

​
position
string

The position of the contact person within their company.

Maximum string length: 48
​
email
string<email>

The email address of the contact person. Must be a valid e-mail address or empty.

Maximum string length: 48
​
mobile
string

The mobile phone number of the contact person.

Maximum string length: 24
​
phone
string

The phone number of the contact person.

Maximum string length: 24
​
website
string

The website of this contact. Must be a valid URL.

Maximum string length: 128
​
category
enum<string>

An optional category to associate this contact with.

Available options:
clients,
suppliers,
partners,
team,
leads
​
formOfAddress
string

The form of address of the contact person, e.g. “Dr. med.“

Maximum string length: 24
​
note
string

A custom plain-text note for this contact. May be multi-line.

Maximum string length: 2000
​
vatNumber
string

An optional VAT registry number for this company. Is not validated for any specific format to allow entering values for formats of arbitrary countries.

Maximum string length: 24
​
country
string

Display name of the country of this contact.

Maximum string length: 24
​
secondaryAddressLine
string

An optional secondary address line for the location of this contact.

Maximum string length: 48

Response

Contact was created successfully

​
contact
Contact · object

Represents a contact, such as a supplier, client, partner, lead, etc.