Create leads for prospective customers

Request
Request Body schema: application/json
required
studioId
required
integer <int64>
firstname
required
string [ 0 .. 100 ] characters
firstname2
string [ 0 .. 100 ] characters

addition for Turkey

lastname
required
string [ 0 .. 100 ] characters
lastname2
string [ 0 .. 100 ] characters

addition for Spain

taxId
string [ 0 .. 300 ] characters

addition for Spain and Italy

dateOfBirth
string <date>
email
string [ 0 .. 300 ] characters
gender
string

User will be assigned as UNISEX if no gender is set.

Enum: "MALE" "FEMALE" "UNISEX"
phone
string [ 0 .. 300 ] characters
street
string [ 0 .. 300 ] characters
streetType
string [ 0 .. 300 ] characters

addition for Spain (e.g. calle)

streetBlock
string [ 0 .. 300 ] characters

addition for Spain

portal
string [ 0 .. 300 ] characters

addition for Spain

stairway
string [ 0 .. 300 ] characters

addition for Spain

floor
string [ 0 .. 300 ] characters

addition for Spain

door
string [ 0 .. 300 ] characters

addition for Spain

province
string [ 0 .. 300 ] characters

addition for southern Europe countries (e.g. Madrid)

additionalAddressInformation
string [ 0 .. 300 ] characters

addition for Spain

houseNumber
string [ 0 .. 100 ] characters
city
string [ 0 .. 300 ] characters
zipCode
string [ 0 .. 100 ] characters
countryCode
string [ 0 .. 300 ] characters
locale
string [ 0 .. 300 ] characters

locale of customer as ISO 639-1 two-letter language and country code (e.g. es_ES or de_DE)

notes
string [ 0 .. 1000 ] characters
sourceCampaignId
integer <int64>
object (PublicApiPrivacyConfigurationDto)

Data privacy configuration for marketing purposes. Deprecated. Use communicationPreferences instead.

Array of objects (CustomerCommunicationPreferencesData)

Communication preferences for the customer. If specified, the list must contain an element for each message category.

Responses
200

OK

400

Bad Request

403

Forbidden

404

Not Found

409

Conflict

500

Internal Server Error

post/connect/v1/lead
Request samples
application/json
{
  • "studioId": 0,
  • "firstname": "string",
  • "firstname2": "string",
  • "lastname": "string",
  • "lastname2": "string",
  • "taxId": "string",
  • "dateOfBirth": "2019-08-24",
  • "email": "string",
  • "gender": "MALE",
  • "phone": "string",
  • "street": "Raboisen",
  • "streetType": "string",
  • "streetBlock": "string",
  • "portal": "string",
  • "stairway": "string",
  • "floor": "string",
  • "door": "string",
  • "province": "string",
  • "additionalAddressInformation": "string",
  • "houseNumber": "3-4",
  • "city": "Hamburg",
  • "zipCode": "22099",
  • "countryCode": "DE",
  • "locale": "string",
  • "notes": "any notes about this lead",
  • "sourceCampaignId": 0,
  • "privacyConfiguration": {
    },
  • "communicationPreferences": [
    ]
}