Send User Invite

Issue a magic-link invite to a teammate. Admin-only.

POST/api/v1/identity/dispatch

Request

curl -X POST "<BASE_URL>/api/v1/identity/dispatch" \
  -H "Authorization: Bearer <ACCESS_TOKEN>" \
  -H "X-CQRS-Action: SEND_USER_INVITE" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "jordan.lee@example.com",
    "invited_by": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "role": "SUPER_ADMIN",
    "seed": 1,
    "tenant_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
  }'

Authorization

Minimum role: ManagerThe caller must hold this role or a higher one.
Action: SEND_USER_INVITE

Headers

AuthorizationstringRequired
Access token of the signed-in user, as a Bearer token. It identifies the user, their role and the workspace.
X-CQRS-ActionstringRequired
Names the command to run. Must be SEND_USER_INVITE for this endpoint.
Content-TypestringRequired
Always application/json.
X-Idempotency-KeystringOptional
A key you choose that is unique to this attempt. A command repeated with the same key is not applied a second time.
X-Correlation-IdstringOptional
Your own identifier for the request. Returned in the x-correlation-id response header; generated when you leave it out.

Request body

emailemailRequired
No description yet.
invited_byuuidRequired
Owner / admin minting the invite. Stamped on the invite row for the audit trail.
roleenumRequired
Role the invitee becomes on accept. Engine refuses TenantAdmin / SuperAdmin via this surface — those require a direct DB grant.
Allowed values
- SUPER_ADMIN
- TENANT_ADMIN
- MANAGER
- REP
- VIEWER
- DEAL_DESK_APPROVER
- REV_OPS_ADMIN
- FINANCE
- EXTERNAL_AUDITOR
- AGENT
- SYSTEM
SYSTEM
Internal system actor — autonomous orchestrator, scheduled job, or other non-human dispatcher. Distinct from Agent (autonomous AI agent acting on behalf of a user) because system actions bypass some user-scoped guards (e.g. "this user can't see X").
seedintegerRequired
Per-request seed (Go-supplied) for token generation.
at least 0
tenant_iduuidRequired
No description yet.

Response

Status 202. The command was applied. The body reports the outcome and, where the command changes a record, that record's new state.

successbooleanRequired
true when the command was applied.
error_messagestringRequired
Empty when the command was applied.
projected_stateobjectOptional
The record as it stands after the command.
event_payloadobjectOptional
The event the command recorded.
insightsarray of objectOptional
Advisory notes about the result. Each has a code, a message and an impact number.

Errors

Every error carries an HTTP status. Where it also carries a code, branch on the code, not on the message.

400X-CQRS-Action is missing or names a command this route does not accept. Send SEND_USER_INVITE.
400DOMAIN_ROUTINGThe body is not a valid command. Check the required fields and their types.
401The access token is missing, expired or not valid.
401L1_AUTHThe caller's role is below manager or the caller has no access to this record.
403L1_POLICYA business rule refused the command. The message names the rule.
409L1_IDEMPOTENCYA command with this idempotency key was already applied.
409CONFLICTThe command would duplicate a record that must be unique.
500L3_COMMITThe command was valid but could not be saved.