translate

Not in your language

This page is not yet available in en. You're reading the de version.

CRM Module

Das CRM-Modul ist eines der ältesten und meistgenutzten in aYOUne. Es liefert Lead- und Customer-Management, Task-Tracking und Notiz-Funktionen — alles unter crm-api.ayoune.app.

Routing

https://crm-api.ayoune.app/consumers
https://crm-api.ayoune.app/tasks
https://crm-api.ayoune.app/notes

Hauptentitäten

Consumers

End-User des Customers (also: deine Endkunden, deine Leads). Schema-Kern:

Feld	Typ	Pflicht	Hinweis
`_id`	ObjectId	auto
`email`	string	ja	unique pro Customer
`first_name`	string	nein	snake_case!
`last_name`	string	nein	snake_case!
`profilepicture`	string	nein	URL — auch snake_case
`phone`	string	nein	E.164-Format
`country`	string	nein	ISO-3166-Alpha-2
`_status`	enum	auto	`lead`, `active`, `churned`
`customCRM`	object	nein	Tenant-spezifische Felder
`tags`	string[]	nein	Free-Text-Tags

Achtung: Die Felder heißen tatsächlich snake_case (first_name, nicht firstName) — historisch gewachsen. Das name-Virtual liefert " ()" und sollte NICHT in OR-Defaults verwendet werden (Symptom: " (Demo-Account)").

Rights: crm.consumers.{view|create|edit|delete}.

Tasks

ToDos, Tickets, Bugs (intern). Felder:

Feld	Hinweis
`title`	Pflicht
`description`	Markdown
`assignedTo`	UserId
`consumer`	ConsumerId (optional)
`dueDate`	Date
`priority`	`low` / `medium` / `high` / `critical`
`type`	`Task` / `Bug` / `Feature`
`_status`	`open` / `in-progress` / `done`

Plattform-Konvention: Runtime-Errors landen als Tasks mit type: "Bug" (siehe Error Codes). Read-Side-Filter blendet sie für normale Sales-User aus.

Rights: crm.tasks.{view|create|edit|delete|assign}.

Notes

Freitext-Annotations zu Consumers, Tasks oder beliebigen anderen Datensätzen.

Feld	Hinweis
`body`	Markdown
`targetType`	Collection-Name
`targetId`	ObjectId
`pinned`	bool

Custom-Actions

POST /consumers/:id/actions/anonymize
POST /consumers/:id/actions/merge --body '{"keepId":"<otherId>"}'
POST /tasks/:id/actions/assign --body '{"userId":"<id>"}'
POST /tasks/:id/actions/reopen

Sub-Resources

GET  /consumers/:id/tasks       # Tasks zu einem Consumer
GET  /consumers/:id/notes       # Notes zu einem Consumer
GET  /consumers/:id/maillogs    # E-Mail-History (cross-module)
GET  /consumers/:id/orders      # Bestellungen (wenn shop-modul aktiv)

Cross-Module-Verbindungen

Marketing liest Consumers für Newsletter-Empfänger (Marketing-Module)
Automation triggert auf Consumer-Events (Automation-Module)
Reporting aggregiert Consumer-KPIs (Lead-Conversion, etc.)

Beispiel: Lead-Pipeline

# Lead anlegen
ay create consumers "lead@example.com" \
  --set first_name=Anna --set _status=lead

# Task an Sales-Mitarbeiter zuweisen
ay create tasks "Lead Anna anrufen" \
  --set consumer=<consumerId> \
  --set assignedTo=<userId> \
  --set priority=high

# Notiz festhalten
ay create notes \
  --set body="Anna hat Interesse an Premium-Plan" \
  --set targetType=consumers --set targetId=<consumerId>

Siehe auch: Marketing, Automation.

Work with this page

Ready-made instructions for your AI tool. Copy, paste, go — the AI fetches the content itself via the address in the text.

Summarise the steps for me The essentials, in the right order.

Open in ChatGPT

Read the following documentation by tolinax UG and work with it.

This page: https://ayoune.com/en/docs/api-reference/crm-module.md
The complete collection: https://ayoune.com/en/docs/api-reference.md

Summarise the content for me.

- First, in two sentences: what is this about?
- Then the steps in the order I need to take them.
- One line per step, in plain language.
- At the end: what I should have ready beforehand.

Leave out nothing I need in order to actually finish.
A note on sources:
- Every page of this documentation is available as Markdown (the same address with `.md`).
- A machine-readable overview of all public content is at `/llms.txt`.
- If you have access to the aYOUne MCP server, you can work against live data
  instead of this snapshot. If not, ignore this point.

Help me set this up Step by step, asking me as you go.

Open in ChatGPT

Read the following documentation by tolinax UG and work with it.

This page: https://ayoune.com/en/docs/api-reference/crm-module.md
The complete collection: https://ayoune.com/en/docs/api-reference.md

Walk me through the setup step by step.

- First tell me what I need to have ready (access, data, time).
- Then take me through ONE step at a time. Wait for my "next".
- For each step, say how I can tell that it worked.
- If something goes wrong, ask me for the exact message instead of guessing.

If the instructions leave a point open, tell me so rather than inventing it.
A note on sources:
- Every page of this documentation is available as Markdown (the same address with `.md`).
- A machine-readable overview of all public content is at `/llms.txt`.
- If you have access to the aYOUne MCP server, you can work against live data
  instead of this snapshot. If not, ignore this point.

Help me with a problem Narrow down the cause instead of guessing.

Open in ChatGPT

Read the following documentation by tolinax UG and work with it.

This page: https://ayoune.com/en/docs/api-reference/crm-module.md
The complete collection: https://ayoune.com/en/docs/api-reference.md

Help me narrow down a problem.

- First ask me what I observe and what I expected instead.
- From that, derive the most likely causes consistent with this source.
- For each cause, give me ONE test that confirms or rules it out.
- Order them so the cheapest test comes first.

Do not guess. If the source does not cover the problem, tell me where I should
look next.
A note on sources:
- Every page of this documentation is available as Markdown (the same address with `.md`).
- A machine-readable overview of all public content is at `/llms.txt`.
- If you have access to the aYOUne MCP server, you can work against live data
  instead of this snapshot. If not, ignore this point.

Explain it in plain words No jargon, from the ground up.

Open in ChatGPT

Read the following documentation by tolinax UG and work with it.

This page: https://ayoune.com/en/docs/api-reference/crm-module.md
The complete collection: https://ayoune.com/en/docs/api-reference.md

Explain the content so that someone without prior knowledge understands it.

- Start with the purpose: why does this exist at all?
- Explain technical terms in half a sentence on first use.
- One everyday comparison where it genuinely holds — none where it limps.
- At the end: the three things worth remembering.

Do not shorten by dropping conditions. A simplification that hides a
prerequisite is a false statement.
A note on sources:
- Every page of this documentation is available as Markdown (the same address with `.md`).
- A machine-readable overview of all public content is at `/llms.txt`.
- If you have access to the aYOUne MCP server, you can work against live data
  instead of this snapshot. If not, ignore this point.

A checklist to tick off To follow along while you do it.

Open in ChatGPT

Read the following documentation by tolinax UG and work with it.

This page: https://ayoune.com/en/docs/api-reference/crm-module.md
The complete collection: https://ayoune.com/en/docs/api-reference.md

Turn this into a **tick-off checklist** for practical use.

- Exactly one action per item, in the imperative.
- Order it so that no item depends on a later prerequisite.
- Prerequisites and pitfalls as indented sub-items.
- End with an acceptance step: how do I know everything is right?
A note on sources:
- Every page of this documentation is available as Markdown (the same address with `.md`).
- A machine-readable overview of all public content is at `/llms.txt`.
- If you have access to the aYOUne MCP server, you can work against live data
  instead of this snapshot. If not, ignore this point.

Build it into my project Concrete code for my use case.

Open in ChatGPT

Read the following documentation by tolinax UG and work with it.

This page: https://ayoune.com/en/docs/api-reference/crm-module.md
The complete collection: https://ayoune.com/en/docs/api-reference.md

Help me build this into my project.

- First ask me about language, environment and what I am trying to achieve.
- Then give a minimal, runnable example — no ellipses standing in for code.
- Name the error cases I must handle and how they surface.
- State the limits: timeouts, quotas, permissions.

Use only what the source actually describes. Do not invent fields, parameters
or endpoints — an invented call costs me more time than it saves.
A note on sources:
- Every page of this documentation is available as Markdown (the same address with `.md`).
- A machine-readable overview of all public content is at `/llms.txt`.
- If you have access to the aYOUne MCP server, you can work against live data
  instead of this snapshot. If not, ignore this point.

Was this article helpful?

👎 No (0)