My account

Routes are relative to <PUBLIC_BASE_URL>; request and response bodies are JSON unless stated otherwise. Authentication, scopes, pagination and the error format are described in the REST API guides.

PATCH /api/v1/me

Change my display name

Only the name: the address is the sign-in identifier and stays read-only. No audit line.

Access — Member session or API key with scope profile:write.

Request body (application/json)

Field	Type	Required
name	string	yes

JSON Schema

{
  "type": "object",
  "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 } },
  "required": [ "name" ]
}

Responses

200 — The member, renamed.

Field	Type	Required
member	object	yes

JSON Schema

{
  "type": "object",
  "properties": {
    "member": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        "email": { "type": "string" },
        "name": { "type": "string" },
        "role": { "type": "string", "enum": [ "member", "admin" ] },
        "status": { "type": "string", "enum": [ "active", "suspended" ] }
      },
      "required": [ "id", "email", "name", "role", "status" ],
      "additionalProperties": false
    }
  },
  "required": [ "member" ],
  "additionalProperties": false
}

400 — The request does not match its schema.

401 — No valid session or API key (auth.unauthenticated).

403 — Refused: insufficient role (auth.forbidden), missing scope (api_key.scope_missing, details.required names it) or a route closed to API keys (api_key.session_required).

429 — The API key exceeded its rate limit (api_key.rate_limited); Retry-After says when to retry.

Error codes — auth.invalid_settings. The common codes (request.bad_request, auth.unauthenticated, api_key.scope_missing, api_key.rate_limited…) apply to every route; see Errors.

PATCH /api/v1/me/settings

Change my preferences

Locale, display mode and theme. Only the keys present are written; an empty body changes nothing and returns the current preferences.

Access — Member session or API key with scope profile:write.

Request body (application/json)

Field	Type	Required
locale	"fr" | "en"	no
theme	"light" | "dark" | "system"	no
themeName	"classic" | "meridian" | "atelier"	no

JSON Schema

{
  "type": "object",
  "properties": {
    "locale": { "type": "string", "enum": [ "fr", "en" ] },
    "theme": { "type": "string", "enum": [ "light", "dark", "system" ] },
    "themeName": { "type": "string", "enum": [ "classic", "meridian", "atelier" ] }
  }
}

Responses

200 — The preferences, after write.

Field	Type	Required
settings	object	yes

JSON Schema

{
  "type": "object",
  "properties": {
    "settings": {
      "type": "object",
      "properties": {
        "locale": { "type": "string", "enum": [ "fr", "en" ] },
        "theme": { "type": "string", "enum": [ "light", "dark", "system" ] },
        "themeName": { "type": "string", "enum": [ "classic", "meridian", "atelier" ] }
      },
      "additionalProperties": false
    }
  },
  "required": [ "settings" ],
  "additionalProperties": false
}

400 — The request does not match its schema.

401 — No valid session or API key (auth.unauthenticated).

403 — Refused: insufficient role (auth.forbidden), missing scope (api_key.scope_missing, details.required names it) or a route closed to API keys (api_key.session_required).

429 — The API key exceeded its rate limit (api_key.rate_limited); Retry-After says when to retry.

Error codes — auth.invalid_settings. The common codes (request.bad_request, auth.unauthenticated, api_key.scope_missing, api_key.rate_limited…) apply to every route; see Errors.

POST /api/v1/me/password

Change my password

Requires the current password. Shares the sign-in rate limit (per IP). A wrong current password is a 403, not a 401: the session stays valid. Optionally revokes the other sessions. Recorded in the audit log.

Access — Member session only: API keys are refused (api_key.session_required).

Request body (application/json)

Field	Type	Required
currentPassword	string	yes
newPassword	string	yes
revokeOtherSessions	boolean	no

JSON Schema

{
  "type": "object",
  "properties": {
    "currentPassword": { "type": "string", "minLength": 1, "maxLength": 256 },
    "newPassword": { "type": "string", "minLength": 12, "maxLength": 256 },
    "revokeOtherSessions": { "default": true, "type": "boolean" }
  },
  "required": [ "currentPassword", "newPassword" ]
}

Responses

204 — Changed.

400 — The request does not match its schema.

401 — No valid session or API key (auth.unauthenticated).

403 — Refused: insufficient role (auth.forbidden), missing scope (api_key.scope_missing, details.required names it) or a route closed to API keys (api_key.session_required).

429 — The API key exceeded its rate limit (api_key.rate_limited); Retry-After says when to retry.

Error codes — auth.too_many_attempts, auth.weak_password, auth.invalid_credentials, auth.invalid_current_password. The common codes (request.bad_request, auth.unauthenticated, api_key.scope_missing, api_key.rate_limited…) apply to every route; see Errors.

GET /api/v1/scope

Read my ingestion scope

Access — Member session or API key with scope profile:read.

Responses

200 — The member scope.

Field	Type	Required
scope	object	yes

JSON Schema

{
  "type": "object",
  "properties": {
    "scope": {
      "type": "object",
      "properties": {
        "mode": { "type": "string", "enum": [ "exclude", "include" ] },
        "domains": {
          "maxItems": 500,
          "type": "array",
          "items": { "type": "string", "minLength": 1, "maxLength": 320 }
        },
        "emails": {
          "maxItems": 500,
          "type": "array",
          "items": { "type": "string", "minLength": 1, "maxLength": 320 }
        }
      },
      "required": [ "mode", "domains", "emails" ],
      "additionalProperties": false
    }
  },
  "required": [ "scope" ],
  "additionalProperties": false
}

401 — No valid session or API key (auth.unauthenticated).

403 — Refused: insufficient role (auth.forbidden), missing scope (api_key.scope_missing, details.required names it) or a route closed to API keys (api_key.session_required).

429 — The API key exceeded its rate limit (api_key.rate_limited); Retry-After says when to retry.

PUT /api/v1/scope

Replace my ingestion scope

A full replacement, not a patch. Applies to future ingestion only; nothing is replayed on past executions. The response is the normalised form.

Access — Member session or API key with scope profile:write.

Request body (application/json)

Field	Type	Required
mode	"exclude" | "include"	no
domains	string[]	no
emails	string[]	no

JSON Schema

{
  "type": "object",
  "properties": {
    "mode": { "default": "exclude", "type": "string", "enum": [ "exclude", "include" ] },
    "domains": {
      "default": [],
      "maxItems": 500,
      "type": "array",
      "items": { "type": "string", "minLength": 1, "maxLength": 320 }
    },
    "emails": {
      "default": [],
      "maxItems": 500,
      "type": "array",
      "items": { "type": "string", "minLength": 1, "maxLength": 320 }
    }
  }
}

Responses

200 — The member scope, normalised.

Field	Type	Required
scope	object	yes

Same schema as GET /api/v1/scope.

400 — The request does not match its schema.

401 — No valid session or API key (auth.unauthenticated).

403 — Refused: insufficient role (auth.forbidden), missing scope (api_key.scope_missing, details.required names it) or a route closed to API keys (api_key.session_required).

429 — The API key exceeded its rate limit (api_key.rate_limited); Retry-After says when to retry.

Error codes — request.bad_request, governance.not_found. The common codes (request.bad_request, auth.unauthenticated, api_key.scope_missing, api_key.rate_limited…) apply to every route; see Errors.

GET /api/v1/dispatch-policy

Read my dispatch policy

Access — Member session or API key with scope profile:read.

Responses

200 — The policy.

Field	Type	Required
policy	object	yes

JSON Schema

{
  "type": "object",
  "properties": {
    "policy": {
      "type": "object",
      "properties": { "mode": { "type": "string", "enum": [ "all", "priority" ] } },
      "required": [ "mode" ],
      "additionalProperties": false
    }
  },
  "required": [ "policy" ],
  "additionalProperties": false
}

401 — No valid session or API key (auth.unauthenticated).

403 — Refused: insufficient role (auth.forbidden), missing scope (api_key.scope_missing, details.required names it) or a route closed to API keys (api_key.session_required).

429 — The API key exceeded its rate limit (api_key.rate_limited); Retry-After says when to retry.

PUT /api/v1/dispatch-policy

Set my dispatch policy

Switches between all (every matching workflow runs) and priority (only the first, by workflow priority). The order itself is set per workflow.

Access — Member session or API key with scope profile:write.

Request body (application/json)

Field	Type	Required
mode	"all" | "priority"	yes

JSON Schema

{
  "type": "object",
  "properties": { "mode": { "type": "string", "enum": [ "all", "priority" ] } },
  "required": [ "mode" ]
}

Responses

200 — The policy.

Field	Type	Required
policy	object	yes

Same schema as GET /api/v1/dispatch-policy.

400 — The request does not match its schema.

401 — No valid session or API key (auth.unauthenticated).

403 — Refused: insufficient role (auth.forbidden), missing scope (api_key.scope_missing, details.required names it) or a route closed to API keys (api_key.session_required).

429 — The API key exceeded its rate limit (api_key.rate_limited); Retry-After says when to retry.

Error codes — request.bad_request, governance.not_found. The common codes (request.bad_request, auth.unauthenticated, api_key.scope_missing, api_key.rate_limited…) apply to every route; see Errors.