Create a lead (tenant:crm:write)
POST /api/crm/v1/leads
Module: CRM · operationId: createLead · Tag: Leads · Auth: access token (Authorization: Bearer <accessToken>)
The lead starts with status NEW. Without source it is the tenant's defaultLeadSource
(else MANUAL); without ownerEmail the owner is the calling person; without score it is
calculated (lead scoring, see Model). customFields are validated against the tenant's
definitions (400, invalid_custom_fields). Leads with the same normalised company name or the
same e-mail address (also masterdata addresses) are duplicates: the answer is 409
(code: duplicate_lead, candidates, masterdataUnavailable) unless force is true.
Emits crm.lead.created (and crm.lead.assigned for an owner other than the caller).
Request body
application/json (required)
company(string, required): Company name. (max length 255)contactName(string, required): Name of the contact person. (max length 255)campaignId(string (uuid)): A campaign of the tenant (422otherwise).consent(boolean): GDPR consent to be contacted.consentSource(string): Where the consent was given. (max length 255)customFields(object): Values by field key; validated against the tenant's definitions (400,invalid_custom_fields).email(string (email)): E-mail address. (max length 255)force(boolean): Create the lead although duplicates were found (otherwise409,duplicate_lead). (defaultfalse)marketingOptOut(boolean): The person objected to marketing.notes(string): Notes. (max length 10000)ownerEmail(string (email)): Default: the calling person. (max length 255)phone(string): Phone number. (max length 64)score(integer): Default is the data quality score. (max 100)source(string): DefaultMANUAL. (max length 64)vatId(string): VAT ID. (max length 32)website(string): Website. (max length 512)
Example:
{
"company": "Müller Haustechnik GmbH",
"contactName": "Sabine Müller",
"email": "s.mueller@mueller-haustechnik.de",
"notes": "Interesse an Wartungsvertrag für drei Standorte.",
"phone": "+49 89 1234567",
"source": "WEBSITE"
}
Responses
- 201 Created (
application/json) - 400 Invalid input (
invalid):fieldnames the first invalid field,details.fieldsevery one (JSON paths for bodies, parameter names for the query). Some refusals have their own code (invalid_sort,invalid_stages,invalid_custom_fields,convert_target_required,invalid_csv, …). (application/json) - 401 Missing, invalid or expired token (no body).
- 403 The token lacks the permission (
insufficient permissions) or has no active tenant. (application/json) - 409 Leads or addresses that look like the new lead exist (
code: duplicate_lead); repeat the request withforce: trueto create it anyway. (application/json) - 500 Unexpected error; details are only logged. (
application/json)
Fields of the 201 answer:
company(string, required): Company name.contactName(string, required): Name of the contact person.createdAt(string (date-time), required): Creation time.customerNo(string, required): Customer number of the tenant.id(string (uuid), required): Id of the lead.score(integer, required): Lead score 0–100. (max 100)source(string, required): Free text. The portal offers the codesMANUAL,WEBSITE,FAIR,IMPORT,REFERRAL,CAMPAIGN,PHONEandOTHER; these are stored in upper case (importbecomesIMPORT), any other value is kept as written. A CSV import without a source column writesIMPORT.status(LeadStatus, required): (one ofNEW,CONTACTED,QUALIFIED,LOST,CONVERTED)tenantName(string, required): Tenant name.updatedAt(string (date-time), required): Time of the last change.anonymizedAt(string (date-time), read-only): Set when the retention job removed the personal data; omitted otherwise.campaignId(string (uuid)): Campaign the lead comes from; omitted when not set.consent(boolean): GDPR consent to be contacted.consentAt(string (date-time), read-only): Set by the server whenconsentturns true.consentSource(string): Where the consent was given; omitted when not set.convertedAddressId(string (uuid)): Masterdata address after conversion; omitted before.customFields(object): Values of the tenant's lead fields by field key (CRMSettings.customFields.lead).email(string): Omitted when not set.marketingOptOut(boolean): The person objected to marketing.notes(string): Omitted when not set.ownerEmail(string): Employee responsible for the lead (lower-case e-mail); omitted when not set.phone(string): Omitted when not set.vatCheckedAt(string (date-time), read-only): Time of that check.vatId(string): Omitted when not set.vatStatus(string, read-only): Status of the lastvalidateVatIdwith this lead (see itsstatusvalues); omitted before.website(string): Omitted when not set.
Example 201 answer:
{
"campaignId": "2a4c6e8a-0b2d-4f4a-8c6e-8a0c2e4a6c8e",
"company": "Brauerei Gaßner GmbH \u0026 Co. KG",
"consent": true,
"consentAt": "2026-07-19T15:40:00Z",
"consentSource": "Visitenkarte am Messestand",
"contactName": "Eva Gaßner",
"createdAt": "2026-07-19T15:40:00Z",
"customFields": {
"branche": "gastronomie",
"mitarbeitende": 45
},
"customerNo": "99999",
"email": "eva.gassner@brauerei-gassner.example",
"id": "5b7d9f1a-3c5e-4a7b-9d1f-3a5c7e9b1d3f",
"marketingOptOut": false,
"notes": "Hat am Messestand nach WLAN für Sudhaus und Lager gefragt. Termin vor Ort hat stattgefunden, Angebot in Arbeit.",
"ownerEmail": "lena.vogel@muster-it.example",
"phone": "+49 9441 50070",
"score": 80,
"source": "FAIR",
"status": "QUALIFIED",
"tenantName": "DEMO",
"updatedAt": "2026-10-28T10:20:00Z",
"vatCheckedAt": "2026-10-28T10:02:14Z",
"vatId": "DE999000231",
"vatStatus": "OFFICIALLY_CONFIRMED",
"website": "https://www.brauerei-gassner.example"
}
Example request
curl -X POST 'https://api.mbcom.cloud/api/crm/v1/leads' \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
--data '{"company":"Müller Haustechnik GmbH","contactName":"Sabine Müller","email":"s.mueller@mueller-haustechnik.de","notes":"Interesse an Wartungsvertrag für drei Standorte.","phone":"+49 89 1234567","source":"WEBSITE"}'