API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · function_roles

Function Role Schema

Schema-ID
function_role
Collection
function_roles
Permissions
  • Lesenfunction_role_view
  • Anlegenfunction_role_create
  • Ändernfunction_role_edit
  • Löschenfunction_role_delete

Felder

Function Role Schema

function_roles4 Permissions

Tenant-managed taxonomy slug for contact function roles (`party_relationship.functionRoles`). See docs/specs/campaigns.md §Recipient-Resolver.

slugstringerforderlich

Uppercase snake-case slug used in party_relationship.functionRoles[] and the recipient-resolver. Immutable after creation.

1–50 ZeichenPatternread-only
labelDestringerforderlich

German label shown in the CRM UI.

1–100 Zeichen
labelEnstringoptional

English label (optional). Falls back to labelDe if missing.

max 100 Zeichennullable
descriptionstringoptional
max 500 Zeichennullable
enabledbooleanoptional

If false, the role is hidden from pickers but existing assignments remain valid.

Default: true
allowsCustomTextbooleanoptional

If true, contacts with this role get a free-text supplement field (classic "OTHER" behaviour).

Default: false
sortOrderintegeroptional
0 – 9999Default: 100
isBuiltInbooleanoptional

True for roles seeded from FUNCTION_ROLES constants. Built-in roles cannot be deleted, only disabled.

Default: falseread-only
colorstringoptional

Optional hex color for role badges in the CRM.

Patternnullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/function_roles — Liste, paginiert + filterbar
  • GET /api/v1/function_roles/<id> — Einzelne Entity
  • POST /api/v1/function_roles — Anlegen
  • PATCH /api/v1/function_roles/<id> — Teil-Update
  • DELETE /api/v1/function_roles/<id> — Soft-Delete
  • GET /api/v1/function_roles/<id>/timeline — Audit + Aktivitäten

Suche