Search
K
[dev] 🇩🇪 Seeker Leads Ingest DE

Ingest Seeker leads API Germany

1.1.3OAS 3.0

The Ingest Seeker leads API allows partners to create new leads on IWT
The onboarding process & advice is available in the “Use cases” menu of the developer portal.
Please share your questions & feedbacks on the following address : leads-api@aviv-group.com

API Base URL
  • Server 1:https://api.aviv-group.com/seeker-leads-ingest-de/v1

    Production server

  • Server 2:https://api.aviv-group.com/sandbox/seeker-leads-ingest-de/v1

    Sandbox

Security
bearerAuth (http)

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123

Creates a new lead.

The route accepts a lead object in the request body to create a new lead.

post

Body

application/json

createLeadRequest

firstNamestring

Maximum length is 100 characters

>= 1 characters<= 100 characters

Example:Jane

lastNamestringrequired

Maximum length is 100 characters

>= 1 characters<= 100 characters

Example:Doe

genderstring

Allowed values:MALEFEMALEOTHERPREFER_NOT_TO_DISCLOSE

Example:FEMALE

emailstring(email)required

Example:test@example.com

languagestring

Allowed values:DEENESFRHEITNLPTRU

Default:DE

Example:DE

phoneNumbersarray[object]
Show Child Parameters
streetstring

>= 1 characters<= 300 characters

Example:My Street Name

houseNumberstring

>= 1 characters<= 100 characters

Example:10a

apartmentNumberstring

>= 1 characters<= 300 characters

Example:101

postalCodestring

>= 1 characters<= 15 characters

Example:92841

citystring

>= 1 characters<= 150 characters

Example:My Town Name

countrystring

>= 1 characters<= 150 characters

Example:Germany

messagestringrequired
classifiedIdstringrequired

Classified identifier in the format ^([0-9]{2})([1-9A-NP-Z]{10})$

Match pattern:^([0-9]{2})([1-9A-NP-Z]{10})$

submittedDatestring(date-time)required

The date and time when the lead was submitted in ISO 8601 format

Response

application/json

Immediate response with 200 status code

requestIdstring

The ID of the request processing ID

post/leads

Body

{ "lastName": "Doe", "email": "test@example.com", "message": "message", "classifiedId": "classifiedId", "submittedDate": "submittedDate" }
 
application/json

createLeadRequest

object
firstNamestring

Maximum length is 100 characters

>= 1 characters<= 100 characters

Example:Jane

lastNamestringrequired

Maximum length is 100 characters

>= 1 characters<= 100 characters

Example:Doe

genderstring

Allowed values:MALEFEMALEOTHERPREFER_NOT_TO_DISCLOSE

Example:FEMALE

emailstring(email)required

Example:test@example.com

languagestring

Allowed values:DEENESFRHEITNLPTRU

Default:DE

Example:DE

phoneNumbersarray[object]
Show Child Parameters
streetstring

>= 1 characters<= 300 characters

Example:My Street Name

houseNumberstring

>= 1 characters<= 100 characters

Example:10a

apartmentNumberstring

>= 1 characters<= 300 characters

Example:101

postalCodestring

>= 1 characters<= 15 characters

Example:92841

citystring

>= 1 characters<= 150 characters

Example:My Town Name

countrystring

>= 1 characters<= 150 characters

Example:Germany

messagestringrequired
classifiedIdstringrequired

Classified identifier in the format ^([0-9]{2})([1-9A-NP-Z]{10})$

Match pattern:^([0-9]{2})([1-9A-NP-Z]{10})$

submittedDatestring(date-time)required

The date and time when the lead was submitted in ISO 8601 format

Example