API docs by Redocly

contact API (develop:c14720)

Download OpenAPI specification:

License: None

Automatically generated swagger spec for the contact stack.

VcardService

CsvService

ContactService

ContactService_Activate

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

ContactService_CheckDuplicates

Request Body schema: application/json
required
required
object (commonaddressAddress)
emails
required
Array of strings
firstName
required
string
isCompany
required
boolean
name
required
string

Either company name if isCompany=true, otherwise lastName of person.

ownerId
required
string <int64>
phoneNumbers
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "emails": [
    ],
  • "firstName": "string",
  • "isCompany": true,
  • "name": "string",
  • "ownerId": "string",
  • "phoneNumbers": [
    ]
}

Response samples

Content type
application/json
{
  • "companies": [
    ],
  • "persons": [
    ]
}

ContactService_CopyContacts

Request Body schema: application/json
required
sourceAccountId
required
string <int64>
targetTargetId
required
string <int64>

Responses

Request samples

Content type
application/json
{
  • "sourceAccountId": "string",
  • "targetTargetId": "string"
}

Response samples

Content type
application/json
{ }

ContactService_CreateCompany

Request Body schema: application/json
required
required
object (commonaddressAddress)
required
Array of objects (v2AddressEntry)
documentIds
required
Array of strings
email
required
string (official contact email of the company, not the email of the responsible person (e.g. info@company.com))
iban
required
string
includeInSerialEmails
required
boolean
industries
required
Array of strings (industryIndustry)
Items Enum: "INDUSTRY_UNDEFINED_VALUE" "INDUSTRY_LIVING_FURNISHING_HOUSEHOLD_APPLIANCES" "INDUSTRY_LIVING_FURNISHING_MAINTENANCE" "INDUSTRY_LIVING_FURNISHING_REAL_ESTATE" "INDUSTRY_LIVING_FURNISHING_INTERIOR_DESIGN" "INDUSTRY_LIVING_FURNISHING_INTERIOR_DECORATION" "INDUSTRY_LIVING_FURNISHING_KITCHEN_FACILITIES" "INDUSTRY_LIVING_FURNISHING_REAL_ESTATE_TRADING" "INDUSTRY_LIVING_FURNISHING_REAL_ESTATE_MANAGEMENT" "INDUSTRY_LIVING_FURNISHING_FURNITURE" "INDUSTRY_LIVING_FURNISHING_CLEANING" "INDUSTRY_LIVING_FURNISHING_KEY_SERVICE" "INDUSTRY_LIVING_FURNISHING_BLINDS_AND_SHUTTERS" "INDUSTRY_LIVING_FURNISHING_CARPETS" "INDUSTRY_LIVING_FURNISHING_MOVING" "INDUSTRY_LIVING_FURNISHING_CURTAINS" "INDUSTRY_LIVING_FURNISHING_OTHER" "INDUSTRY_BUILD_RENOVATE_ARCHITECTURE" "INDUSTRY_BUILD_RENOVATE_CONSTRUCTION" "INDUSTRY_BUILD_RENOVATE_ROOFING" "INDUSTRY_BUILD_RENOVATE_FLOORING_WALL_COVERINGS" "INDUSTRY_BUILD_RENOVATE_PLASTERER" "INDUSTRY_BUILD_RENOVATE_HEATING" "INDUSTRY_BUILD_RENOVATE_WOOD_CONSTRUCTION" "INDUSTRY_BUILD_RENOVATE_ENGINEERING" "INDUSTRY_BUILD_RENOVATE_PAINTER" "INDUSTRY_BUILD_RENOVATE_METAL_CONSTRUCTION" "INDUSTRY_BUILD_RENOVATE_SANITARY" "INDUSTRY_BUILD_RENOVATE_LOCKSMITH" "INDUSTRY_BUILD_RENOVATE_JOINERY" "INDUSTRY_BUILD_RENOVATE_PLUMBING" "INDUSTRY_BUILD_RENOVATE_CARPENTRY" "INDUSTRY_BUILD_RENOVATE_ELECTRICIAN" "INDUSTRY_BUILD_RENOVATE_CRAFTSMAN" "INDUSTRY_BUILD_RENOVATE_OTHER" "INDUSTRY_FINANCIAL_LAW_ADVOCACY" "INDUSTRY_FINANCIAL_LAW_BANK" "INDUSTRY_FINANCIAL_LAW_ACCOUNTING" "INDUSTRY_FINANCIAL_LAW_FINANCIAL_CONSULTING" "INDUSTRY_FINANCIAL_LAW_NOTARY" "INDUSTRY_FINANCIAL_LAW_LAWYER" "INDUSTRY_FINANCIAL_LAW_TAX_CONSULTING" "INDUSTRY_FINANCIAL_LAW_TRUSTEESHIP" "INDUSTRY_FINANCIAL_LAW_ASSET_MANAGEMENT" "INDUSTRY_FINANCIAL_LAW_INSURANCE" "INDUSTRY_FINANCIAL_LAW_OTHER" "INDUSTRY_GARDEN_PLANTS_FLORIST" "INDUSTRY_GARDEN_PLANTS_HORTICULTURE" "INDUSTRY_GARDEN_PLANTS_GARDEN_MAINTENANCE" "INDUSTRY_GARDEN_PLANTS_NURSERY" "INDUSTRY_GARDEN_PLANTS_DUMPSTER_SERVICE" "INDUSTRY_GARDEN_PLANTS_OTHER" "INDUSTRY_OTHER_METER_READING" "INDUSTRY_OTHER_FACILITY_MANAGEMENT" "INDUSTRY_OTHER_MAINTENANCE_INSTALLATION" "INDUSTRY_OTHER_BUILDING_SERVICES_ENGINEERING" "INDUSTRY_OTHER_KEY_SERVICE" "INDUSTRY_OTHER_CLEANING" "INDUSTRY_OTHER_WHITE_GOODS" "INDUSTRY_OTHER_OTHER" "INDUSTRY_OTHER_FIRE_PROTECTION" "INDUSTRY_BUILD_RENOVATE_FACADES" "INDUSTRY_OTHER_ELECTRICITY_PLANT" "INDUSTRY_OTHER_WATERWORKS" "INDUSTRY_OTHER_SWEEPINGS" "INDUSTRY_OTHER_ANTENNA_SYSTEM" "INDUSTRY_OTHER_PEST_CONTROL" "INDUSTRY_FINANCIAL_LAW_PUBLIC_SECTOR" "INDUSTRY_BUILD_RENOVATE_DISTRICT_HEATING" "INDUSTRY_BUILD_RENOVATE_AIR_CONDITIONING" "INDUSTRY_BUILD_RENOVATE_GARAGE_GATES" "INDUSTRY_BUILD_RENOVATE_MOLD_CONTROL" "INDUSTRY_OTHER_MARKINGS" "INDUSTRY_BUILD_RENOVATE_JOINTS" "INDUSTRY_OTHER_OIL" "INDUSTRY_BUILD_RENOVATE_LIFT_SERVICE" "INDUSTRY_OTHER_WATER_TREATMENT" "INDUSTRY_OTHER_ADVERTISING" "INDUSTRY_OTHER_GROCERIES" "INDUSTRY_OTHER_CAR_DEALERSHIP" "INDUSTRY_OTHER_STATIONERY_SHOP" "INDUSTRY_BUILD_GLAZIER" "INDUSTRY_BUILD_SCAFFOLDER" "INDUSTRY_OTHER_CHIMNEY_SWEEPER" "INDUSTRY_OTHER_ENGRAVING" "INDUSTRY_BUILD_MASONRY" "INDUSTRY_CONSTRUCTION_MANAGEMENT" "INDUSTRY_SEWER_CLEANING" "INDUSTRY_NATURE_CONSERVATION" "INDUSTRY_GEOMATICS" "INDUSTRY_DECONSTRUCTION" "INDUSTRY_GEOLOGIST" "INDUSTRY_POLLUTANT_EXPERT" "INDUSTRY_INSULATION" "INDUSTRY_LOCKING_SYSTEMS"
legalForm
required
string (v2LegalForm)
Default: "LEGAL_FORM_UNDEFINED"
Enum: "LEGAL_FORM_UNDEFINED" "LEGAL_FORM_PUBLIC_LIMITED_COMPANY" "LEGAL_FORM_LIMITED_LIABILITY_COMPANY" "LEGAL_FORM_SIMPLE_PARTNERSHIP" "LEGAL_FORM_GENERAL_PARTNERSHIP" "LEGAL_FORM_LIMITED_PARTNERSHIP" "LEGAL_FORM_SOLE_PROPRIETORSHIP" "LEGAL_FORM_COOPERATIVE" "LEGAL_FORM_ASSOCIATION" "LEGAL_FORM_FOUNDATION" "LEGAL_FORM_OTHER"
name
required
string
note
required
string
numericId
required
string <int64>
ownerId
required
string <int64>
required
Array of objects (PhoneNumber stores phoneNumbers)
portalAccess
required
boolean
preferredCommunicationChannel
required
string (v2PreferredCommunicationChannel)
Default: "PREFERRED_COMMUNICATION_CHANNEL_UNDEFINED"
Enum: "PREFERRED_COMMUNICATION_CHANNEL_UNDEFINED" "PREFERRED_COMMUNICATION_CHANNEL_EMAIL" "PREFERRED_COMMUNICATION_CHANNEL_LETTER"
preferredLanguage
required
string (languagePreferredLanguage)
Default: "PREFERRED_LANGUAGE_UNDEFINED"
Enum: "PREFERRED_LANGUAGE_UNDEFINED" "PREFERRED_LANGUAGE_GERMAN" "PREFERRED_LANGUAGE_ENGLISH" "PREFERRED_LANGUAGE_ITALIAN" "PREFERRED_LANGUAGE_FRENCH"
salutationName
required
string
tags
required
Array of strings
types
required
Array of strings (contactcontactv2Type)
Items Enum: "NONE" "LANDLORD" "CLIENT" "TENANT" "EMPLOYEE" "CARETAKER" "SERVICE_PROVIDER" "INTERESTED_PARTY" "BANK" "INSURANCE" "REAL_ESTATE_MANAGER" "CRAFTSMAN" "AUTHORITY" "ACCOUNTANT" "MARKETER" "CONDOMINIUM_OWNER" "SUB_TENANT" "REPRESENTATION" "COOPERATIVE" "SALE" "EXTERNAL_DEBTOR" "GUARANTOR" "REVISOR" "DELEGATE" "BOARD" "OWNER"
uniqueEnterpriseIdentification
required
string
vatNumber
required
string
website
required
string

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "addressHistory": [
    ],
  • "documentIds": [
    ],
  • "email": "string",
  • "iban": "string",
  • "includeInSerialEmails": true,
  • "industries": [
    ],
  • "legalForm": "LEGAL_FORM_UNDEFINED",
  • "name": "string",
  • "note": "string",
  • "numericId": "string",
  • "ownerId": "string",
  • "phoneNumbers": [
    ],
  • "portalAccess": true,
  • "preferredCommunicationChannel": "PREFERRED_COMMUNICATION_CHANNEL_UNDEFINED",
  • "preferredLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
  • "salutationName": "string",
  • "tags": [
    ],
  • "types": [
    ],
  • "uniqueEnterpriseIdentification": "string",
  • "vatNumber": "string",
  • "website": "string"
}

Response samples

Content type
application/json
{
  • "company": {
    }
}

ContactService_CreatePerson

Request Body schema: application/json
required
required
object (commonaddressAddress)
required
Array of objects (v2AddressEntry)
ahv
required
string
birthName
required
string
birthplace
required
string
civilStatus
required
string (contactcontactv2CivilStatus)
Default: "UNDEFINED_CIVIL_STATUS"
Enum: "UNDEFINED_CIVIL_STATUS" "CIVIL_STATUS_SINGLE" "CIVIL_STATUS_MARRIED" "CIVIL_STATUS_DIVORCED" "CIVIL_STATUS_WIDOWED" "CIVIL_STATUS_SEPARATED" "CIVIL_STATUS_REGISTERED_PARTNERSHIP" "CIVIL_STATUS_DISSOLVED_PARTNERSHIP"
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

documentIds
required
Array of strings
email
required
string
required
object (contactcontactv2Employment)
firstName
required
string
gender
required
string (contactcontactv2Gender)
Default: "UNDEFINED_GENDER"
Enum: "UNDEFINED_GENDER" "MALE" "FEMALE" "OTHER" "HEIRS"
iban
required
string
industries
required
Array of strings (industryIndustry)
Items Enum: "INDUSTRY_UNDEFINED_VALUE" "INDUSTRY_LIVING_FURNISHING_HOUSEHOLD_APPLIANCES" "INDUSTRY_LIVING_FURNISHING_MAINTENANCE" "INDUSTRY_LIVING_FURNISHING_REAL_ESTATE" "INDUSTRY_LIVING_FURNISHING_INTERIOR_DESIGN" "INDUSTRY_LIVING_FURNISHING_INTERIOR_DECORATION" "INDUSTRY_LIVING_FURNISHING_KITCHEN_FACILITIES" "INDUSTRY_LIVING_FURNISHING_REAL_ESTATE_TRADING" "INDUSTRY_LIVING_FURNISHING_REAL_ESTATE_MANAGEMENT" "INDUSTRY_LIVING_FURNISHING_FURNITURE" "INDUSTRY_LIVING_FURNISHING_CLEANING" "INDUSTRY_LIVING_FURNISHING_KEY_SERVICE" "INDUSTRY_LIVING_FURNISHING_BLINDS_AND_SHUTTERS" "INDUSTRY_LIVING_FURNISHING_CARPETS" "INDUSTRY_LIVING_FURNISHING_MOVING" "INDUSTRY_LIVING_FURNISHING_CURTAINS" "INDUSTRY_LIVING_FURNISHING_OTHER" "INDUSTRY_BUILD_RENOVATE_ARCHITECTURE" "INDUSTRY_BUILD_RENOVATE_CONSTRUCTION" "INDUSTRY_BUILD_RENOVATE_ROOFING" "INDUSTRY_BUILD_RENOVATE_FLOORING_WALL_COVERINGS" "INDUSTRY_BUILD_RENOVATE_PLASTERER" "INDUSTRY_BUILD_RENOVATE_HEATING" "INDUSTRY_BUILD_RENOVATE_WOOD_CONSTRUCTION" "INDUSTRY_BUILD_RENOVATE_ENGINEERING" "INDUSTRY_BUILD_RENOVATE_PAINTER" "INDUSTRY_BUILD_RENOVATE_METAL_CONSTRUCTION" "INDUSTRY_BUILD_RENOVATE_SANITARY" "INDUSTRY_BUILD_RENOVATE_LOCKSMITH" "INDUSTRY_BUILD_RENOVATE_JOINERY" "INDUSTRY_BUILD_RENOVATE_PLUMBING" "INDUSTRY_BUILD_RENOVATE_CARPENTRY" "INDUSTRY_BUILD_RENOVATE_ELECTRICIAN" "INDUSTRY_BUILD_RENOVATE_CRAFTSMAN" "INDUSTRY_BUILD_RENOVATE_OTHER" "INDUSTRY_FINANCIAL_LAW_ADVOCACY" "INDUSTRY_FINANCIAL_LAW_BANK" "INDUSTRY_FINANCIAL_LAW_ACCOUNTING" "INDUSTRY_FINANCIAL_LAW_FINANCIAL_CONSULTING" "INDUSTRY_FINANCIAL_LAW_NOTARY" "INDUSTRY_FINANCIAL_LAW_LAWYER" "INDUSTRY_FINANCIAL_LAW_TAX_CONSULTING" "INDUSTRY_FINANCIAL_LAW_TRUSTEESHIP" "INDUSTRY_FINANCIAL_LAW_ASSET_MANAGEMENT" "INDUSTRY_FINANCIAL_LAW_INSURANCE" "INDUSTRY_FINANCIAL_LAW_OTHER" "INDUSTRY_GARDEN_PLANTS_FLORIST" "INDUSTRY_GARDEN_PLANTS_HORTICULTURE" "INDUSTRY_GARDEN_PLANTS_GARDEN_MAINTENANCE" "INDUSTRY_GARDEN_PLANTS_NURSERY" "INDUSTRY_GARDEN_PLANTS_DUMPSTER_SERVICE" "INDUSTRY_GARDEN_PLANTS_OTHER" "INDUSTRY_OTHER_METER_READING" "INDUSTRY_OTHER_FACILITY_MANAGEMENT" "INDUSTRY_OTHER_MAINTENANCE_INSTALLATION" "INDUSTRY_OTHER_BUILDING_SERVICES_ENGINEERING" "INDUSTRY_OTHER_KEY_SERVICE" "INDUSTRY_OTHER_CLEANING" "INDUSTRY_OTHER_WHITE_GOODS" "INDUSTRY_OTHER_OTHER" "INDUSTRY_OTHER_FIRE_PROTECTION" "INDUSTRY_BUILD_RENOVATE_FACADES" "INDUSTRY_OTHER_ELECTRICITY_PLANT" "INDUSTRY_OTHER_WATERWORKS" "INDUSTRY_OTHER_SWEEPINGS" "INDUSTRY_OTHER_ANTENNA_SYSTEM" "INDUSTRY_OTHER_PEST_CONTROL" "INDUSTRY_FINANCIAL_LAW_PUBLIC_SECTOR" "INDUSTRY_BUILD_RENOVATE_DISTRICT_HEATING" "INDUSTRY_BUILD_RENOVATE_AIR_CONDITIONING" "INDUSTRY_BUILD_RENOVATE_GARAGE_GATES" "INDUSTRY_BUILD_RENOVATE_MOLD_CONTROL" "INDUSTRY_OTHER_MARKINGS" "INDUSTRY_BUILD_RENOVATE_JOINTS" "INDUSTRY_OTHER_OIL" "INDUSTRY_BUILD_RENOVATE_LIFT_SERVICE" "INDUSTRY_OTHER_WATER_TREATMENT" "INDUSTRY_OTHER_ADVERTISING" "INDUSTRY_OTHER_GROCERIES" "INDUSTRY_OTHER_CAR_DEALERSHIP" "INDUSTRY_OTHER_STATIONERY_SHOP" "INDUSTRY_BUILD_GLAZIER" "INDUSTRY_BUILD_SCAFFOLDER" "INDUSTRY_OTHER_CHIMNEY_SWEEPER" "INDUSTRY_OTHER_ENGRAVING" "INDUSTRY_BUILD_MASONRY" "INDUSTRY_CONSTRUCTION_MANAGEMENT" "INDUSTRY_SEWER_CLEANING" "INDUSTRY_NATURE_CONSERVATION" "INDUSTRY_GEOMATICS" "INDUSTRY_DECONSTRUCTION" "INDUSTRY_GEOLOGIST" "INDUSTRY_POLLUTANT_EXPERT" "INDUSTRY_INSULATION" "INDUSTRY_LOCKING_SYSTEMS"
lastName
required
string
name
required
string (name is the full name of the person. It can be the only field set if no firstName+lastName separation is possible. If 'firstName' and 'lastName' are set and 'name' is not, name is set to: firstName + ' ' + lastName)
nationality
required
string
note
required
string
numericId
required
string <int64>
ownerId
required
string <int64>
required
Array of objects (PhoneNumber stores phoneNumbers)
preferredCommunicationChannel
required
string (v2PreferredCommunicationChannel)
Default: "PREFERRED_COMMUNICATION_CHANNEL_UNDEFINED"
Enum: "PREFERRED_COMMUNICATION_CHANNEL_UNDEFINED" "PREFERRED_COMMUNICATION_CHANNEL_EMAIL" "PREFERRED_COMMUNICATION_CHANNEL_LETTER"
preferredLanguage
required
string (languagePreferredLanguage)
Default: "PREFERRED_LANGUAGE_UNDEFINED"
Enum: "PREFERRED_LANGUAGE_UNDEFINED" "PREFERRED_LANGUAGE_GERMAN" "PREFERRED_LANGUAGE_ENGLISH" "PREFERRED_LANGUAGE_ITALIAN" "PREFERRED_LANGUAGE_FRENCH"
residenceStatus
required
string (contactcontactv2ResidenceStatus)
Default: "UNDEFINED_RESIDENCE_STATUS"
Enum: "UNDEFINED_RESIDENCE_STATUS" "RESIDENCE_STATUS_B_STAY" "RESIDENCE_STATUS_C_SETTLE" "RESIDENCE_STATUS_CI_STAY_EMPLOYMENT" "RESIDENCE_STATUS_G_BORDER_CROSSER" "RESIDENCE_STATUS_L_SHORT_STAY" "RESIDENCE_STATUS_F_PRELIMINARY_FOREIGNER" "RESIDENCE_STATUS_N_SEEKING_ASYLUM" "RESIDENCE_STATUS_S_PROTECTION_NEEDED" "RESIDENCE_STATUS_NO_STATUS"

ResidenceStatus provides an enumeration for the different swiss residence status a person can have.

  • RESIDENCE_STATUS_B_STAY: B - Aufenthaltsbewilligung
  • RESIDENCE_STATUS_C_SETTLE: C - Niederlassungsbewilligung
  • RESIDENCE_STATUS_CI_STAY_EMPLOYMENT: Ci - Aufenthaltsbewilligung mit Erwerbstätigkeit
  • RESIDENCE_STATUS_G_BORDER_CROSSER: G - Grenzgängerbewilligung
  • RESIDENCE_STATUS_L_SHORT_STAY: L - Kurzaufenthaltsbewilligung
  • RESIDENCE_STATUS_F_PRELIMINARY_FOREIGNER: F - Vorläufig aufgenommene Ausländer
  • RESIDENCE_STATUS_N_SEEKING_ASYLUM: N - Asylsuchender
  • RESIDENCE_STATUS_S_PROTECTION_NEEDED: S - Schutzbedürftige
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

salutationName
required
string
tags
required
Array of strings
title
required
string
types
required
Array of strings (contactcontactv2Type)
Items Enum: "NONE" "LANDLORD" "CLIENT" "TENANT" "EMPLOYEE" "CARETAKER" "SERVICE_PROVIDER" "INTERESTED_PARTY" "BANK" "INSURANCE" "REAL_ESTATE_MANAGER" "CRAFTSMAN" "AUTHORITY" "ACCOUNTANT" "MARKETER" "CONDOMINIUM_OWNER" "SUB_TENANT" "REPRESENTATION" "COOPERATIVE" "SALE" "EXTERNAL_DEBTOR" "GUARANTOR" "REVISOR" "DELEGATE" "BOARD" "OWNER"
website
required
string
required
object (v2AdditionalEmail)

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "addressHistory": [
    ],
  • "ahv": "string",
  • "birthName": "string",
  • "birthplace": "string",
  • "civilStatus": "UNDEFINED_CIVIL_STATUS",
  • "dateOfBirth": {
    },
  • "dateOfDeath": {
    },
  • "documentIds": [
    ],
  • "email": "string",
  • "employment": {
    },
  • "firstName": "string",
  • "gender": "UNDEFINED_GENDER",
  • "iban": "string",
  • "industries": [
    ],
  • "lastName": "string",
  • "name": "string",
  • "nationality": "string",
  • "note": "string",
  • "numericId": "string",
  • "ownerId": "string",
  • "phoneNumbers": [
    ],
  • "preferredCommunicationChannel": "PREFERRED_COMMUNICATION_CHANNEL_UNDEFINED",
  • "preferredLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
  • "residenceStatus": "UNDEFINED_RESIDENCE_STATUS",
  • "residenceStatusValidUntil": {
    },
  • "salutationName": "string",
  • "tags": [
    ],
  • "title": "string",
  • "types": [
    ],
  • "website": "string",
  • "workEmail": {
    }
}

Response samples

Content type
application/json
{
  • "person": {
    }
}

ContactService_Deactivate

Request Body schema: application/json
required
ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json
{ }

ContactService_Delete

path Parameters
ids
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{ }

ContactService_DuplicateContacts

Request Body schema: application/json
required
ids
required
Array of strings
targetOwnerId
required
string <int64>

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "targetOwnerId": "string"
}

Response samples

Content type
application/json
{
  • "companies": [
    ],
  • "persons": [
    ]
}

ContactService_GetOwnerContact

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "company": {
    },
  • "person": {
    }
}

ContactService_GetUsedTags

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "tags": [
    ]
}

ContactService_LinkCompanies

Request Body schema: application/json
required
required
Array of objects (v2Relation)

Responses

Request samples

Content type
application/json
{
  • "relations": [
    ]
}

Response samples

Content type
application/json
{ }

ContactService_LinkPersons

Request Body schema: application/json
required
required
Array of objects (v2Relation)

Responses

Request samples

Content type
application/json
{
  • "relations": [
    ]
}

Response samples

Content type
application/json
{ }

ContactService_List

path Parameters
ownerId
required
string <int64>

The accountId of the owner of the contact (!not the accountId of the contact itself!)

Responses

Response samples

Content type
application/json
{
  • "companies": [
    ],
  • "persons": [
    ]
}

ContactService_ListEmployees

path Parameters
ownerId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "persons": [
    ]
}

ContactService_ListForPhoneProvider

path Parameters
accountId
required
string <int64>

Returns owned contacts and contacts shared with this account.

Responses

Response samples

Content type
application/json
{
  • "companies": [
    ],
  • "persons": [
    ]
}

ContactService_PublishUpdatedEvents

Request Body schema: application/json
required
ownerIds
required
Array of strings <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "ownerIds": [
    ]
}

Response samples

Content type
application/json
{ }

ContactService_Resolve

Request Body schema: application/json
required
contactIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIds": [
    ]
}

Response samples

Content type
application/json
{
  • "companies": [
    ],
  • "persons": [
    ]
}

ContactService_ResolveByMail

path Parameters
ownerId
required
string <int64>

Account ID of the owner of the contact to resolve

Request Body schema: application/json
required
emails
Array of strings

Responses

Request samples

Content type
application/json
{
  • "emails": [
    ]
}

Response samples

Content type
application/json
{
  • "companies": [
    ],
  • "persons": [
    ]
}

ContactService_ResolveByMailMultipleOwners

Request Body schema: application/json
required
emails
required
Array of strings
ownerIds
required
Array of strings <int64> [ items <int64 > ]

Responses

Request samples

Content type
application/json
{
  • "emails": [
    ],
  • "ownerIds": [
    ]
}

Response samples

Content type
application/json
{
  • "companies": [
    ],
  • "persons": [
    ]
}

ContactService_ResolveEmployees

Request Body schema: application/json
required
emails
required
Array of strings
ownerId
required
string <int64>

Responses

Request samples

Content type
application/json
{
  • "emails": [
    ],
  • "ownerId": "string"
}

Response samples

Content type
application/json
{
  • "persons": [
    ]
}

ContactService_SearchByMail

path Parameters
email
required
string

Responses

Response samples

Content type
application/json
{
  • "companies": [
    ],
  • "persons": [
    ]
}

ContactService_SetAddress

Request Body schema: application/json
required
required
object (commonaddressAddress)
ids
required
Array of strings
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "ids": [
    ],
  • "validFrom": {
    }
}

Response samples

Content type
application/json
{
  • "companies": [
    ],
  • "persons": [
    ]
}

ContactService_UnLinkCompanies

Request Body schema: application/json
required
required
Array of objects (v2Relation)

Responses

Request samples

Content type
application/json
{
  • "relations": [
    ]
}

Response samples

Content type
application/json
{ }

ContactService_UnLinkPersons

Request Body schema: application/json
required
required
Array of objects (v2Relation)

Responses

Request samples

Content type
application/json
{
  • "relations": [
    ]
}

Response samples

Content type
application/json
{ }

ContactService_UpdateAddressHistory

Request Body schema: application/json
required
required
object (commonaddressAddress)
ids
required
Array of strings
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "ids": [
    ],
  • "oldValidFrom": {
    },
  • "validFrom": {
    }
}

Response samples

Content type
application/json
{
  • "companies": [
    ],
  • "persons": [
    ]
}

ContactService_AddContactPerson

path Parameters
companyContactId
required
string
Request Body schema: application/json
required
object (commonaddressAddress)
birthName
string
birthplace
string
civilStatus
string (contactcontactv2CivilStatus)
Default: "UNDEFINED_CIVIL_STATUS"
Enum: "UNDEFINED_CIVIL_STATUS" "CIVIL_STATUS_SINGLE" "CIVIL_STATUS_MARRIED" "CIVIL_STATUS_DIVORCED" "CIVIL_STATUS_WIDOWED" "CIVIL_STATUS_SEPARATED" "CIVIL_STATUS_REGISTERED_PARTNERSHIP" "CIVIL_STATUS_DISSOLVED_PARTNERSHIP"
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

email
string
object (contactcontactv2Employment)
firstName
string
gender
string (contactcontactv2Gender)
Default: "UNDEFINED_GENDER"
Enum: "UNDEFINED_GENDER" "MALE" "FEMALE" "OTHER" "HEIRS"
includeInSerialEmails
boolean
lastName
string
name
string (name is the full name of the person. It can be the only field set if no firstName+lastName separation is possible. If 'firstName' and 'lastName' are set and 'name' is not, name is set to: firstName + ' ' + lastName)
nationality
string
note
string
numericId
string <int64>
Array of objects (PhoneNumber stores phoneNumbers)
portalAccess
boolean
preferredLanguage
string (languagePreferredLanguage)
Default: "PREFERRED_LANGUAGE_UNDEFINED"
Enum: "PREFERRED_LANGUAGE_UNDEFINED" "PREFERRED_LANGUAGE_GERMAN" "PREFERRED_LANGUAGE_ENGLISH" "PREFERRED_LANGUAGE_ITALIAN" "PREFERRED_LANGUAGE_FRENCH"
residenceStatus
string (contactcontactv2ResidenceStatus)
Default: "UNDEFINED_RESIDENCE_STATUS"
Enum: "UNDEFINED_RESIDENCE_STATUS" "RESIDENCE_STATUS_B_STAY" "RESIDENCE_STATUS_C_SETTLE" "RESIDENCE_STATUS_CI_STAY_EMPLOYMENT" "RESIDENCE_STATUS_G_BORDER_CROSSER" "RESIDENCE_STATUS_L_SHORT_STAY" "RESIDENCE_STATUS_F_PRELIMINARY_FOREIGNER" "RESIDENCE_STATUS_N_SEEKING_ASYLUM" "RESIDENCE_STATUS_S_PROTECTION_NEEDED" "RESIDENCE_STATUS_NO_STATUS"

ResidenceStatus provides an enumeration for the different swiss residence status a person can have.

  • RESIDENCE_STATUS_B_STAY: B - Aufenthaltsbewilligung
  • RESIDENCE_STATUS_C_SETTLE: C - Niederlassungsbewilligung
  • RESIDENCE_STATUS_CI_STAY_EMPLOYMENT: Ci - Aufenthaltsbewilligung mit Erwerbstätigkeit
  • RESIDENCE_STATUS_G_BORDER_CROSSER: G - Grenzgängerbewilligung
  • RESIDENCE_STATUS_L_SHORT_STAY: L - Kurzaufenthaltsbewilligung
  • RESIDENCE_STATUS_F_PRELIMINARY_FOREIGNER: F - Vorläufig aufgenommene Ausländer
  • RESIDENCE_STATUS_N_SEEKING_ASYLUM: N - Asylsuchender
  • RESIDENCE_STATUS_S_PROTECTION_NEEDED: S - Schutzbedürftige
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

salutationName
string
title
string

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "birthName": "string",
  • "birthplace": "string",
  • "civilStatus": "UNDEFINED_CIVIL_STATUS",
  • "dateOfBirth": {
    },
  • "dateOfDeath": {
    },
  • "email": "string",
  • "employment": {
    },
  • "firstName": "string",
  • "gender": "UNDEFINED_GENDER",
  • "includeInSerialEmails": true,
  • "lastName": "string",
  • "name": "string",
  • "nationality": "string",
  • "note": "string",
  • "numericId": "string",
  • "phoneNumbers": [
    ],
  • "portalAccess": true,
  • "preferredLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
  • "residenceStatus": "UNDEFINED_RESIDENCE_STATUS",
  • "residenceStatusValidUntil": {
    },
  • "salutationName": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "contactPerson": {
    }
}

ContactService_DeleteContactPersons

path Parameters
companyContactId
required
string
Request Body schema: application/json
required
contactPersonIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactPersonIds": [
    ]
}

Response samples

Content type
application/json
{ }

ContactService_UpdateContactPerson

path Parameters
companyContactId
required
string
contactPersonId
required
string
Request Body schema: application/json
required
object (commonaddressAddress)
birthName
string
birthplace
string
civilStatus
string (contactcontactv2CivilStatus)
Default: "UNDEFINED_CIVIL_STATUS"
Enum: "UNDEFINED_CIVIL_STATUS" "CIVIL_STATUS_SINGLE" "CIVIL_STATUS_MARRIED" "CIVIL_STATUS_DIVORCED" "CIVIL_STATUS_WIDOWED" "CIVIL_STATUS_SEPARATED" "CIVIL_STATUS_REGISTERED_PARTNERSHIP" "CIVIL_STATUS_DISSOLVED_PARTNERSHIP"
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

email
string
object (contactcontactv2Employment)
firstName
string
gender
string (contactcontactv2Gender)
Default: "UNDEFINED_GENDER"
Enum: "UNDEFINED_GENDER" "MALE" "FEMALE" "OTHER" "HEIRS"
includeInSerialEmails
boolean
lastName
string
name
string (name is the full name of the person. It can be the only field set if no firstName+lastName separation is possible. If 'firstName' and 'lastName' are set and 'name' is not, name is set to: firstName + ' ' + lastName)
nationality
string
note
string
Array of objects (PhoneNumber stores phoneNumbers)
portalAccess
boolean
preferredLanguage
string (languagePreferredLanguage)
Default: "PREFERRED_LANGUAGE_UNDEFINED"
Enum: "PREFERRED_LANGUAGE_UNDEFINED" "PREFERRED_LANGUAGE_GERMAN" "PREFERRED_LANGUAGE_ENGLISH" "PREFERRED_LANGUAGE_ITALIAN" "PREFERRED_LANGUAGE_FRENCH"
residenceStatus
string (contactcontactv2ResidenceStatus)
Default: "UNDEFINED_RESIDENCE_STATUS"
Enum: "UNDEFINED_RESIDENCE_STATUS" "RESIDENCE_STATUS_B_STAY" "RESIDENCE_STATUS_C_SETTLE" "RESIDENCE_STATUS_CI_STAY_EMPLOYMENT" "RESIDENCE_STATUS_G_BORDER_CROSSER" "RESIDENCE_STATUS_L_SHORT_STAY" "RESIDENCE_STATUS_F_PRELIMINARY_FOREIGNER" "RESIDENCE_STATUS_N_SEEKING_ASYLUM" "RESIDENCE_STATUS_S_PROTECTION_NEEDED" "RESIDENCE_STATUS_NO_STATUS"

ResidenceStatus provides an enumeration for the different swiss residence status a person can have.

  • RESIDENCE_STATUS_B_STAY: B - Aufenthaltsbewilligung
  • RESIDENCE_STATUS_C_SETTLE: C - Niederlassungsbewilligung
  • RESIDENCE_STATUS_CI_STAY_EMPLOYMENT: Ci - Aufenthaltsbewilligung mit Erwerbstätigkeit
  • RESIDENCE_STATUS_G_BORDER_CROSSER: G - Grenzgängerbewilligung
  • RESIDENCE_STATUS_L_SHORT_STAY: L - Kurzaufenthaltsbewilligung
  • RESIDENCE_STATUS_F_PRELIMINARY_FOREIGNER: F - Vorläufig aufgenommene Ausländer
  • RESIDENCE_STATUS_N_SEEKING_ASYLUM: N - Asylsuchender
  • RESIDENCE_STATUS_S_PROTECTION_NEEDED: S - Schutzbedürftige
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

salutationName
string
title
string

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "birthName": "string",
  • "birthplace": "string",
  • "civilStatus": "UNDEFINED_CIVIL_STATUS",
  • "dateOfBirth": {
    },
  • "dateOfDeath": {
    },
  • "email": "string",
  • "employment": {
    },
  • "firstName": "string",
  • "gender": "UNDEFINED_GENDER",
  • "includeInSerialEmails": true,
  • "lastName": "string",
  • "name": "string",
  • "nationality": "string",
  • "note": "string",
  • "phoneNumbers": [
    ],
  • "portalAccess": true,
  • "preferredLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
  • "residenceStatus": "UNDEFINED_RESIDENCE_STATUS",
  • "residenceStatusValidUntil": {
    },
  • "salutationName": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "contactPerson": {
    }
}

ContactService_AddDocuments

path Parameters
id
required
string
Request Body schema: application/json
required
documentIds
Array of strings

Responses

Request samples

Content type
application/json
{
  • "documentIds": [
    ]
}

Response samples

Content type
application/json
{ }

ContactService_DeleteAddress

path Parameters
id
required
string
Request Body schema: application/json
required
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

Responses

Request samples

Content type
application/json
{
  • "validFrom": {
    }
}

Response samples

Content type
application/json
{
  • "companies": [
    ],
  • "persons": [
    ]
}

ContactService_RemoveDocuments

path Parameters
id
required
string
documentIds
required
Array of strings non-empty

Responses

Response samples

Content type
application/json
{ }

ContactService_UpdateCompany

path Parameters
id
required
string
Request Body schema: application/json
required
object (commonaddressAddress)
email
string (official contact email of the company, not the email of the responsible person (e.g. info@company.com))
iban
string
includeInSerialEmails
boolean
industries
Array of strings (industryIndustry)
Items Enum: "INDUSTRY_UNDEFINED_VALUE" "INDUSTRY_LIVING_FURNISHING_HOUSEHOLD_APPLIANCES" "INDUSTRY_LIVING_FURNISHING_MAINTENANCE" "INDUSTRY_LIVING_FURNISHING_REAL_ESTATE" "INDUSTRY_LIVING_FURNISHING_INTERIOR_DESIGN" "INDUSTRY_LIVING_FURNISHING_INTERIOR_DECORATION" "INDUSTRY_LIVING_FURNISHING_KITCHEN_FACILITIES" "INDUSTRY_LIVING_FURNISHING_REAL_ESTATE_TRADING" "INDUSTRY_LIVING_FURNISHING_REAL_ESTATE_MANAGEMENT" "INDUSTRY_LIVING_FURNISHING_FURNITURE" "INDUSTRY_LIVING_FURNISHING_CLEANING" "INDUSTRY_LIVING_FURNISHING_KEY_SERVICE" "INDUSTRY_LIVING_FURNISHING_BLINDS_AND_SHUTTERS" "INDUSTRY_LIVING_FURNISHING_CARPETS" "INDUSTRY_LIVING_FURNISHING_MOVING" "INDUSTRY_LIVING_FURNISHING_CURTAINS" "INDUSTRY_LIVING_FURNISHING_OTHER" "INDUSTRY_BUILD_RENOVATE_ARCHITECTURE" "INDUSTRY_BUILD_RENOVATE_CONSTRUCTION" "INDUSTRY_BUILD_RENOVATE_ROOFING" "INDUSTRY_BUILD_RENOVATE_FLOORING_WALL_COVERINGS" "INDUSTRY_BUILD_RENOVATE_PLASTERER" "INDUSTRY_BUILD_RENOVATE_HEATING" "INDUSTRY_BUILD_RENOVATE_WOOD_CONSTRUCTION" "INDUSTRY_BUILD_RENOVATE_ENGINEERING" "INDUSTRY_BUILD_RENOVATE_PAINTER" "INDUSTRY_BUILD_RENOVATE_METAL_CONSTRUCTION" "INDUSTRY_BUILD_RENOVATE_SANITARY" "INDUSTRY_BUILD_RENOVATE_LOCKSMITH" "INDUSTRY_BUILD_RENOVATE_JOINERY" "INDUSTRY_BUILD_RENOVATE_PLUMBING" "INDUSTRY_BUILD_RENOVATE_CARPENTRY" "INDUSTRY_BUILD_RENOVATE_ELECTRICIAN" "INDUSTRY_BUILD_RENOVATE_CRAFTSMAN" "INDUSTRY_BUILD_RENOVATE_OTHER" "INDUSTRY_FINANCIAL_LAW_ADVOCACY" "INDUSTRY_FINANCIAL_LAW_BANK" "INDUSTRY_FINANCIAL_LAW_ACCOUNTING" "INDUSTRY_FINANCIAL_LAW_FINANCIAL_CONSULTING" "INDUSTRY_FINANCIAL_LAW_NOTARY" "INDUSTRY_FINANCIAL_LAW_LAWYER" "INDUSTRY_FINANCIAL_LAW_TAX_CONSULTING" "INDUSTRY_FINANCIAL_LAW_TRUSTEESHIP" "INDUSTRY_FINANCIAL_LAW_ASSET_MANAGEMENT" "INDUSTRY_FINANCIAL_LAW_INSURANCE" "INDUSTRY_FINANCIAL_LAW_OTHER" "INDUSTRY_GARDEN_PLANTS_FLORIST" "INDUSTRY_GARDEN_PLANTS_HORTICULTURE" "INDUSTRY_GARDEN_PLANTS_GARDEN_MAINTENANCE" "INDUSTRY_GARDEN_PLANTS_NURSERY" "INDUSTRY_GARDEN_PLANTS_DUMPSTER_SERVICE" "INDUSTRY_GARDEN_PLANTS_OTHER" "INDUSTRY_OTHER_METER_READING" "INDUSTRY_OTHER_FACILITY_MANAGEMENT" "INDUSTRY_OTHER_MAINTENANCE_INSTALLATION" "INDUSTRY_OTHER_BUILDING_SERVICES_ENGINEERING" "INDUSTRY_OTHER_KEY_SERVICE" "INDUSTRY_OTHER_CLEANING" "INDUSTRY_OTHER_WHITE_GOODS" "INDUSTRY_OTHER_OTHER" "INDUSTRY_OTHER_FIRE_PROTECTION" "INDUSTRY_BUILD_RENOVATE_FACADES" "INDUSTRY_OTHER_ELECTRICITY_PLANT" "INDUSTRY_OTHER_WATERWORKS" "INDUSTRY_OTHER_SWEEPINGS" "INDUSTRY_OTHER_ANTENNA_SYSTEM" "INDUSTRY_OTHER_PEST_CONTROL" "INDUSTRY_FINANCIAL_LAW_PUBLIC_SECTOR" "INDUSTRY_BUILD_RENOVATE_DISTRICT_HEATING" "INDUSTRY_BUILD_RENOVATE_AIR_CONDITIONING" "INDUSTRY_BUILD_RENOVATE_GARAGE_GATES" "INDUSTRY_BUILD_RENOVATE_MOLD_CONTROL" "INDUSTRY_OTHER_MARKINGS" "INDUSTRY_BUILD_RENOVATE_JOINTS" "INDUSTRY_OTHER_OIL" "INDUSTRY_BUILD_RENOVATE_LIFT_SERVICE" "INDUSTRY_OTHER_WATER_TREATMENT" "INDUSTRY_OTHER_ADVERTISING" "INDUSTRY_OTHER_GROCERIES" "INDUSTRY_OTHER_CAR_DEALERSHIP" "INDUSTRY_OTHER_STATIONERY_SHOP" "INDUSTRY_BUILD_GLAZIER" "INDUSTRY_BUILD_SCAFFOLDER" "INDUSTRY_OTHER_CHIMNEY_SWEEPER" "INDUSTRY_OTHER_ENGRAVING" "INDUSTRY_BUILD_MASONRY" "INDUSTRY_CONSTRUCTION_MANAGEMENT" "INDUSTRY_SEWER_CLEANING" "INDUSTRY_NATURE_CONSERVATION" "INDUSTRY_GEOMATICS" "INDUSTRY_DECONSTRUCTION" "INDUSTRY_GEOLOGIST" "INDUSTRY_POLLUTANT_EXPERT" "INDUSTRY_INSULATION" "INDUSTRY_LOCKING_SYSTEMS"
legalForm
string (v2LegalForm)
Default: "LEGAL_FORM_UNDEFINED"
Enum: "LEGAL_FORM_UNDEFINED" "LEGAL_FORM_PUBLIC_LIMITED_COMPANY" "LEGAL_FORM_LIMITED_LIABILITY_COMPANY" "LEGAL_FORM_SIMPLE_PARTNERSHIP" "LEGAL_FORM_GENERAL_PARTNERSHIP" "LEGAL_FORM_LIMITED_PARTNERSHIP" "LEGAL_FORM_SOLE_PROPRIETORSHIP" "LEGAL_FORM_COOPERATIVE" "LEGAL_FORM_ASSOCIATION" "LEGAL_FORM_FOUNDATION" "LEGAL_FORM_OTHER"
name
string
note
string
ownerId
string <int64>
Array of objects (PhoneNumber stores phoneNumbers)
portalAccess
boolean
preferredCommunicationChannel
string (v2PreferredCommunicationChannel)
Default: "PREFERRED_COMMUNICATION_CHANNEL_UNDEFINED"
Enum: "PREFERRED_COMMUNICATION_CHANNEL_UNDEFINED" "PREFERRED_COMMUNICATION_CHANNEL_EMAIL" "PREFERRED_COMMUNICATION_CHANNEL_LETTER"
preferredLanguage
string (languagePreferredLanguage)
Default: "PREFERRED_LANGUAGE_UNDEFINED"
Enum: "PREFERRED_LANGUAGE_UNDEFINED" "PREFERRED_LANGUAGE_GERMAN" "PREFERRED_LANGUAGE_ENGLISH" "PREFERRED_LANGUAGE_ITALIAN" "PREFERRED_LANGUAGE_FRENCH"
salutationName
string
tags
Array of strings
types
Array of strings (contactcontactv2Type)
Items Enum: "NONE" "LANDLORD" "CLIENT" "TENANT" "EMPLOYEE" "CARETAKER" "SERVICE_PROVIDER" "INTERESTED_PARTY" "BANK" "INSURANCE" "REAL_ESTATE_MANAGER" "CRAFTSMAN" "AUTHORITY" "ACCOUNTANT" "MARKETER" "CONDOMINIUM_OWNER" "SUB_TENANT" "REPRESENTATION" "COOPERATIVE" "SALE" "EXTERNAL_DEBTOR" "GUARANTOR" "REVISOR" "DELEGATE" "BOARD" "OWNER"
uniqueEnterpriseIdentification
string
vatNumber
string
website
string

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "email": "string",
  • "iban": "string",
  • "includeInSerialEmails": true,
  • "industries": [
    ],
  • "legalForm": "LEGAL_FORM_UNDEFINED",
  • "name": "string",
  • "note": "string",
  • "ownerId": "string",
  • "phoneNumbers": [
    ],
  • "portalAccess": true,
  • "preferredCommunicationChannel": "PREFERRED_COMMUNICATION_CHANNEL_UNDEFINED",
  • "preferredLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
  • "salutationName": "string",
  • "tags": [
    ],
  • "types": [
    ],
  • "uniqueEnterpriseIdentification": "string",
  • "vatNumber": "string",
  • "website": "string"
}

Response samples

Content type
application/json
{
  • "company": {
    }
}

ContactService_UpdateGeneric

path Parameters
id
required
string
Request Body schema: application/json
required
object (commonaddressAddress)
email
string
firstName
string
lastName
string
name
string
Array of objects (PhoneNumber stores phoneNumbers)

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "name": "string",
  • "phoneNumbers": [
    ]
}

Response samples

Content type
application/json
{ }

ContactService_UpdatePerson

path Parameters
id
required
string
Request Body schema: application/json
required
object (commonaddressAddress)
ahv
string
birthName
string
birthplace
string
civilStatus
string (contactcontactv2CivilStatus)
Default: "UNDEFINED_CIVIL_STATUS"
Enum: "UNDEFINED_CIVIL_STATUS" "CIVIL_STATUS_SINGLE" "CIVIL_STATUS_MARRIED" "CIVIL_STATUS_DIVORCED" "CIVIL_STATUS_WIDOWED" "CIVIL_STATUS_SEPARATED" "CIVIL_STATUS_REGISTERED_PARTNERSHIP" "CIVIL_STATUS_DISSOLVED_PARTNERSHIP"
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

email
string
object (contactcontactv2Employment)
firstName
string
gender
string (contactcontactv2Gender)
Default: "UNDEFINED_GENDER"
Enum: "UNDEFINED_GENDER" "MALE" "FEMALE" "OTHER" "HEIRS"
iban
string
industries
Array of strings (industryIndustry)
Items Enum: "INDUSTRY_UNDEFINED_VALUE" "INDUSTRY_LIVING_FURNISHING_HOUSEHOLD_APPLIANCES" "INDUSTRY_LIVING_FURNISHING_MAINTENANCE" "INDUSTRY_LIVING_FURNISHING_REAL_ESTATE" "INDUSTRY_LIVING_FURNISHING_INTERIOR_DESIGN" "INDUSTRY_LIVING_FURNISHING_INTERIOR_DECORATION" "INDUSTRY_LIVING_FURNISHING_KITCHEN_FACILITIES" "INDUSTRY_LIVING_FURNISHING_REAL_ESTATE_TRADING" "INDUSTRY_LIVING_FURNISHING_REAL_ESTATE_MANAGEMENT" "INDUSTRY_LIVING_FURNISHING_FURNITURE" "INDUSTRY_LIVING_FURNISHING_CLEANING" "INDUSTRY_LIVING_FURNISHING_KEY_SERVICE" "INDUSTRY_LIVING_FURNISHING_BLINDS_AND_SHUTTERS" "INDUSTRY_LIVING_FURNISHING_CARPETS" "INDUSTRY_LIVING_FURNISHING_MOVING" "INDUSTRY_LIVING_FURNISHING_CURTAINS" "INDUSTRY_LIVING_FURNISHING_OTHER" "INDUSTRY_BUILD_RENOVATE_ARCHITECTURE" "INDUSTRY_BUILD_RENOVATE_CONSTRUCTION" "INDUSTRY_BUILD_RENOVATE_ROOFING" "INDUSTRY_BUILD_RENOVATE_FLOORING_WALL_COVERINGS" "INDUSTRY_BUILD_RENOVATE_PLASTERER" "INDUSTRY_BUILD_RENOVATE_HEATING" "INDUSTRY_BUILD_RENOVATE_WOOD_CONSTRUCTION" "INDUSTRY_BUILD_RENOVATE_ENGINEERING" "INDUSTRY_BUILD_RENOVATE_PAINTER" "INDUSTRY_BUILD_RENOVATE_METAL_CONSTRUCTION" "INDUSTRY_BUILD_RENOVATE_SANITARY" "INDUSTRY_BUILD_RENOVATE_LOCKSMITH" "INDUSTRY_BUILD_RENOVATE_JOINERY" "INDUSTRY_BUILD_RENOVATE_PLUMBING" "INDUSTRY_BUILD_RENOVATE_CARPENTRY" "INDUSTRY_BUILD_RENOVATE_ELECTRICIAN" "INDUSTRY_BUILD_RENOVATE_CRAFTSMAN" "INDUSTRY_BUILD_RENOVATE_OTHER" "INDUSTRY_FINANCIAL_LAW_ADVOCACY" "INDUSTRY_FINANCIAL_LAW_BANK" "INDUSTRY_FINANCIAL_LAW_ACCOUNTING" "INDUSTRY_FINANCIAL_LAW_FINANCIAL_CONSULTING" "INDUSTRY_FINANCIAL_LAW_NOTARY" "INDUSTRY_FINANCIAL_LAW_LAWYER" "INDUSTRY_FINANCIAL_LAW_TAX_CONSULTING" "INDUSTRY_FINANCIAL_LAW_TRUSTEESHIP" "INDUSTRY_FINANCIAL_LAW_ASSET_MANAGEMENT" "INDUSTRY_FINANCIAL_LAW_INSURANCE" "INDUSTRY_FINANCIAL_LAW_OTHER" "INDUSTRY_GARDEN_PLANTS_FLORIST" "INDUSTRY_GARDEN_PLANTS_HORTICULTURE" "INDUSTRY_GARDEN_PLANTS_GARDEN_MAINTENANCE" "INDUSTRY_GARDEN_PLANTS_NURSERY" "INDUSTRY_GARDEN_PLANTS_DUMPSTER_SERVICE" "INDUSTRY_GARDEN_PLANTS_OTHER" "INDUSTRY_OTHER_METER_READING" "INDUSTRY_OTHER_FACILITY_MANAGEMENT" "INDUSTRY_OTHER_MAINTENANCE_INSTALLATION" "INDUSTRY_OTHER_BUILDING_SERVICES_ENGINEERING" "INDUSTRY_OTHER_KEY_SERVICE" "INDUSTRY_OTHER_CLEANING" "INDUSTRY_OTHER_WHITE_GOODS" "INDUSTRY_OTHER_OTHER" "INDUSTRY_OTHER_FIRE_PROTECTION" "INDUSTRY_BUILD_RENOVATE_FACADES" "INDUSTRY_OTHER_ELECTRICITY_PLANT" "INDUSTRY_OTHER_WATERWORKS" "INDUSTRY_OTHER_SWEEPINGS" "INDUSTRY_OTHER_ANTENNA_SYSTEM" "INDUSTRY_OTHER_PEST_CONTROL" "INDUSTRY_FINANCIAL_LAW_PUBLIC_SECTOR" "INDUSTRY_BUILD_RENOVATE_DISTRICT_HEATING" "INDUSTRY_BUILD_RENOVATE_AIR_CONDITIONING" "INDUSTRY_BUILD_RENOVATE_GARAGE_GATES" "INDUSTRY_BUILD_RENOVATE_MOLD_CONTROL" "INDUSTRY_OTHER_MARKINGS" "INDUSTRY_BUILD_RENOVATE_JOINTS" "INDUSTRY_OTHER_OIL" "INDUSTRY_BUILD_RENOVATE_LIFT_SERVICE" "INDUSTRY_OTHER_WATER_TREATMENT" "INDUSTRY_OTHER_ADVERTISING" "INDUSTRY_OTHER_GROCERIES" "INDUSTRY_OTHER_CAR_DEALERSHIP" "INDUSTRY_OTHER_STATIONERY_SHOP" "INDUSTRY_BUILD_GLAZIER" "INDUSTRY_BUILD_SCAFFOLDER" "INDUSTRY_OTHER_CHIMNEY_SWEEPER" "INDUSTRY_OTHER_ENGRAVING" "INDUSTRY_BUILD_MASONRY" "INDUSTRY_CONSTRUCTION_MANAGEMENT" "INDUSTRY_SEWER_CLEANING" "INDUSTRY_NATURE_CONSERVATION" "INDUSTRY_GEOMATICS" "INDUSTRY_DECONSTRUCTION" "INDUSTRY_GEOLOGIST" "INDUSTRY_POLLUTANT_EXPERT" "INDUSTRY_INSULATION" "INDUSTRY_LOCKING_SYSTEMS"
lastName
string
name
string (name is the full name of the person. It can be the only field set if no firstName+lastName separation is possible. If 'firstName' and 'lastName' are set and 'name' is not, name is set to: firstName + ' ' + lastName)
nationality
string
note
string
ownerId
string <int64>
Array of objects (PhoneNumber stores phoneNumbers)
preferredCommunicationChannel
string (v2PreferredCommunicationChannel)
Default: "PREFERRED_COMMUNICATION_CHANNEL_UNDEFINED"
Enum: "PREFERRED_COMMUNICATION_CHANNEL_UNDEFINED" "PREFERRED_COMMUNICATION_CHANNEL_EMAIL" "PREFERRED_COMMUNICATION_CHANNEL_LETTER"
preferredLanguage
string (languagePreferredLanguage)
Default: "PREFERRED_LANGUAGE_UNDEFINED"
Enum: "PREFERRED_LANGUAGE_UNDEFINED" "PREFERRED_LANGUAGE_GERMAN" "PREFERRED_LANGUAGE_ENGLISH" "PREFERRED_LANGUAGE_ITALIAN" "PREFERRED_LANGUAGE_FRENCH"
residenceStatus
string (contactcontactv2ResidenceStatus)
Default: "UNDEFINED_RESIDENCE_STATUS"
Enum: "UNDEFINED_RESIDENCE_STATUS" "RESIDENCE_STATUS_B_STAY" "RESIDENCE_STATUS_C_SETTLE" "RESIDENCE_STATUS_CI_STAY_EMPLOYMENT" "RESIDENCE_STATUS_G_BORDER_CROSSER" "RESIDENCE_STATUS_L_SHORT_STAY" "RESIDENCE_STATUS_F_PRELIMINARY_FOREIGNER" "RESIDENCE_STATUS_N_SEEKING_ASYLUM" "RESIDENCE_STATUS_S_PROTECTION_NEEDED" "RESIDENCE_STATUS_NO_STATUS"

ResidenceStatus provides an enumeration for the different swiss residence status a person can have.

  • RESIDENCE_STATUS_B_STAY: B - Aufenthaltsbewilligung
  • RESIDENCE_STATUS_C_SETTLE: C - Niederlassungsbewilligung
  • RESIDENCE_STATUS_CI_STAY_EMPLOYMENT: Ci - Aufenthaltsbewilligung mit Erwerbstätigkeit
  • RESIDENCE_STATUS_G_BORDER_CROSSER: G - Grenzgängerbewilligung
  • RESIDENCE_STATUS_L_SHORT_STAY: L - Kurzaufenthaltsbewilligung
  • RESIDENCE_STATUS_F_PRELIMINARY_FOREIGNER: F - Vorläufig aufgenommene Ausländer
  • RESIDENCE_STATUS_N_SEEKING_ASYLUM: N - Asylsuchender
  • RESIDENCE_STATUS_S_PROTECTION_NEEDED: S - Schutzbedürftige
object (Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:)
  • A full date, with non-zero year, month, and day values
  • A month and day value, with a zero year, such as an anniversary
  • A year on its own, with zero month and day values
  • A year and month value, with a zero day, such as a credit card expiration date

Related types are [google.type.TimeOfDay][google.type.TimeOfDay] and google.protobuf.Timestamp.

salutationName
string
tags
Array of strings
title
string
types
Array of strings (contactcontactv2Type)
Items Enum: "NONE" "LANDLORD" "CLIENT" "TENANT" "EMPLOYEE" "CARETAKER" "SERVICE_PROVIDER" "INTERESTED_PARTY" "BANK" "INSURANCE" "REAL_ESTATE_MANAGER" "CRAFTSMAN" "AUTHORITY" "ACCOUNTANT" "MARKETER" "CONDOMINIUM_OWNER" "SUB_TENANT" "REPRESENTATION" "COOPERATIVE" "SALE" "EXTERNAL_DEBTOR" "GUARANTOR" "REVISOR" "DELEGATE" "BOARD" "OWNER"
website
string
object (v2AdditionalEmail)

Responses

Request samples

Content type
application/json
{
  • "address": {
    },
  • "ahv": "string",
  • "birthName": "string",
  • "birthplace": "string",
  • "civilStatus": "UNDEFINED_CIVIL_STATUS",
  • "dateOfBirth": {
    },
  • "dateOfDeath": {
    },
  • "email": "string",
  • "employment": {
    },
  • "firstName": "string",
  • "gender": "UNDEFINED_GENDER",
  • "iban": "string",
  • "industries": [
    ],
  • "lastName": "string",
  • "name": "string",
  • "nationality": "string",
  • "note": "string",
  • "ownerId": "string",
  • "phoneNumbers": [
    ],
  • "preferredCommunicationChannel": "PREFERRED_COMMUNICATION_CHANNEL_UNDEFINED",
  • "preferredLanguage": "PREFERRED_LANGUAGE_UNDEFINED",
  • "residenceStatus": "UNDEFINED_RESIDENCE_STATUS",
  • "residenceStatusValidUntil": {
    },
  • "salutationName": "string",
  • "tags": [
    ],
  • "title": "string",
  • "types": [
    ],
  • "website": "string",
  • "workEmail": {
    }
}

Response samples

Content type
application/json
{
  • "person": {
    }
}

TelephoneService

TelephoneService_Get3CXApiKey

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "apiKey": "string"
}

TelephoneService_Set3CXApiKey

path Parameters
accountId
required
string <int64>
Request Body schema: application/json
required
apiKey
string

Responses

Request samples

Content type
application/json
{
  • "apiKey": "string"
}

Response samples

Content type
application/json
{ }

ActivityService

Create

Request Body schema: application/json
required
contactIds
required
Array of strings
documentIds
required
Array of strings
employeeContactId
required
string
referenceIds
required
Array of strings
subject
required
string
text
required
string
timestamp
required
string <int64> (UNIX timestamp in seconds)

Responses

Request samples

Content type
application/json
{
  • "contactIds": [
    ],
  • "documentIds": [
    ],
  • "employeeContactId": "string",
  • "referenceIds": [
    ],
  • "subject": "string",
  • "text": "string",
  • "timestamp": "string"
}

Response samples

Content type
application/json
{
  • "activity": {
    }
}

Delete

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Read

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "activity": {
    }
}

ActivityService_ListByContactIds

Request Body schema: application/json
required
contactIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "contactIds": [
    ]
}

Response samples

Content type
application/json
{
  • "activities": [
    ]
}

ActivityService_ListByReferenceIdsMixin8

Request Body schema: application/json
required
referenceIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "referenceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "activities": [
    ]
}

Update

path Parameters
id
required
string
Request Body schema: application/json
required
contactIds
Array of strings
documentIds
Array of strings
employeeContactId
string
referenceIds
Array of strings
subject
string
text
string
timestamp
string <int64> (UNIX timestamp in seconds)

Responses

Request samples

Content type
application/json
{
  • "contactIds": [
    ],
  • "documentIds": [
    ],
  • "employeeContactId": "string",
  • "referenceIds": [
    ],
  • "subject": "string",
  • "text": "string",
  • "timestamp": "string"
}

Response samples

Content type
application/json
{ }

Create

Request Body schema: application/json
required
billable
required
boolean
employeeContactIds
required
Array of strings
hasEndTime
required
boolean
hasStartTime
required
boolean
hourlyRate
required
number <double>
mediaIds
required
Array of strings
ownerId
required
string <int64>
required
Array of objects (v3ActivityReference)
source
required
string (v3Source)
Default: "ACTIVITY_SOURCE_UNDEFINED"
Enum: "ACTIVITY_SOURCE_UNDEFINED" "ACTIVITY_SOURCE_PHONE" "ACTIVITY_SOURCE_MAIL" "ACTIVITY_SOURCE_PERSONAL"
subject
required
string
text
required
string
timestampEnd
required
string <int64> (UNIX timestamp in seconds)
timestampStart
required
string <int64> (UNIX timestamp in seconds)

Responses

Request samples

Content type
application/json
{
  • "billable": true,
  • "employeeContactIds": [
    ],
  • "hasEndTime": true,
  • "hasStartTime": true,
  • "hourlyRate": 0.1,
  • "mediaIds": [
    ],
  • "ownerId": "string",
  • "references": [
    ],
  • "source": "ACTIVITY_SOURCE_UNDEFINED",
  • "subject": "string",
  • "text": "string",
  • "timestampEnd": "string",
  • "timestampStart": "string"
}

Response samples

Content type
application/json
{
  • "activity": {
    }
}

Delete

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{ }

Read

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "activity": {
    }
}

ActivityService_ListByReferenceIds

Request Body schema: application/json
required
referenceIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "referenceIds": [
    ]
}

Response samples

Content type
application/json
{
  • "activities": [
    ]
}

Update

path Parameters
id
required
string
Request Body schema: application/json
required
billable
boolean
employeeContactIds
Array of strings
hasEndTime
boolean
hasStartTime
boolean
hourlyRate
number <double>
mediaIds
Array of strings
Array of objects (v3ActivityReference)
source
string (v3Source)
Default: "ACTIVITY_SOURCE_UNDEFINED"
Enum: "ACTIVITY_SOURCE_UNDEFINED" "ACTIVITY_SOURCE_PHONE" "ACTIVITY_SOURCE_MAIL" "ACTIVITY_SOURCE_PERSONAL"
subject
string
text
string
timestampEnd
string <int64> (UNIX timestamp in seconds)
timestampStart
string <int64> (UNIX timestamp in seconds)

Responses

Request samples

Content type
application/json
{
  • "billable": true,
  • "employeeContactIds": [
    ],
  • "hasEndTime": true,
  • "hasStartTime": true,
  • "hourlyRate": 0.1,
  • "mediaIds": [
    ],
  • "references": [
    ],
  • "source": "ACTIVITY_SOURCE_UNDEFINED",
  • "subject": "string",
  • "text": "string",
  • "timestampEnd": "string",
  • "timestampStart": "string"
}

Response samples

Content type
application/json
{ }