api.post.m7.org Endpoint Documentation

Generated on 2026-07-19 from cli/endpoints.php --json, config/general.json, and the PHP handlers under lib/php/thisProject/api.

Conventions

• Base URL: https://api.post.m7.org
• Response format: json; error format: json.
• Request parameters are read from the parsed request payload ($this->r), which may include query, form, or JSON body values depending on the router parser.
• ANY means the route is registered without an HTTP-method constraint. Prefer POST for mutations and request bodies unless the caller contract says otherwise.
• "Detected request fields" are statically extracted from handlers and delegated service methods; table-backed filters may accept additional fields.

Authentication

• M7 token config: check soft, issuer id.m7.org; allowed algorithms RS512.
• Principal route protection from config:
  • /members, /v1/members -> user, admin, root
  • /admin, /v1/admin -> admin, root

Endpoint Summary

Method	Path	Auth	Handler
ANY	/hello	no explicit auth gate detected in route/handler	hello\Controller
ANY	/v1/admin/dne/check	principal route rule: admin, root	admin\dne\Check
ANY	/v1/admin/dne/delete	principal route rule: admin, root	admin\dne\Delete
ANY	/v1/admin/dne/list	principal route rule: admin, root	admin\dne\ListItems
ANY	/v1/admin/dne/save	principal route rule: admin, root	admin\dne\Save
ANY	/v1/admin/domain/delete	principal route rule: admin, root	admin\domain\Delete
ANY	/v1/admin/domain/get	principal route rule: admin, root	admin\domain\Get
ANY	/v1/admin/domain/list	principal route rule: admin, root	admin\domain\ListItems
ANY	/v1/admin/domain/save	principal route rule: admin, root	admin\domain\Save
ANY	/v1/admin/health	principal route rule: admin, root	admin\health\Controller
ANY	/v1/admin/job/get	principal route rule: admin, root	admin\job\Get
ANY	/v1/admin/job/list	principal route rule: admin, root	admin\job\ListItems
ANY	/v1/members/job/activate	principal route rule: user, admin, root	members\job\Activate
ANY	/v1/members/job/cancel	principal route rule: user, admin, root	members\job\Cancel
ANY	/v1/members/job/create	principal route rule: user, admin, root	members\job\Create
ANY	/v1/members/job/get	principal route rule: user, admin, root	members\job\Get
ANY	/v1/members/job/list	principal route rule: user, admin, root	members\job\ListItems
ANY	/v1/members/job/retry	principal route rule: user, admin, root	members\job\Retry
ANY	/v1/members/message/group/delete	principal route rule: user, admin, root	members\message\group\Delete
ANY	/v1/members/message/group/get	principal route rule: user, admin, root	members\message\group\Get
ANY	/v1/members/message/group/list	principal route rule: user, admin, root	members\message\group\ListItems
ANY	/v1/members/message/group/save	principal route rule: user, admin, root	members\message\group\Save
ANY	/v1/members/message/group/template/delete	principal route rule: user, admin, root	members\message\group\template\Delete
ANY	/v1/members/message/group/template/get	principal route rule: user, admin, root	members\message\group\template\Get
ANY	/v1/members/message/group/template/list	principal route rule: user, admin, root	members\message\group\template\ListItems
ANY	/v1/members/message/group/template/save	principal route rule: user, admin, root	members\message\group\template\Save
ANY	/v1/members/message/template/delete	principal route rule: user, admin, root	members\message\template\Delete
ANY	/v1/members/message/template/get	principal route rule: user, admin, root	members\message\template\Get
ANY	/v1/members/message/template/list	principal route rule: user, admin, root	members\message\template\ListItems
ANY	/v1/members/message/template/save	principal route rule: user, admin, root	members\message\template\Save
ANY	/v1/members/policy/delete	principal route rule: user, admin, root	members\policy\Delete
ANY	/v1/members/policy/dne/check	principal route rule: user, admin, root	members\policy\dne\Check
ANY	/v1/members/policy/dne/delete	principal route rule: user, admin, root	members\policy\dne\Delete
ANY	/v1/members/policy/dne/get	principal route rule: user, admin, root	members\policy\dne\Get
ANY	/v1/members/policy/dne/list	principal route rule: user, admin, root	members\policy\dne\ListItems
ANY	/v1/members/policy/dne/save	principal route rule: user, admin, root	members\policy\dne\Save
ANY	/v1/members/policy/domain/check	principal route rule: user, admin, root	members\policy\domain\Check
ANY	/v1/members/policy/domain/delete	principal route rule: user, admin, root	members\policy\domain\Delete
ANY	/v1/members/policy/domain/get	principal route rule: user, admin, root	members\policy\domain\Get
ANY	/v1/members/policy/domain/list	principal route rule: user, admin, root	members\policy\domain\ListItems
ANY	/v1/members/policy/domain/save	principal route rule: user, admin, root	members\policy\domain\Save
ANY	/v1/members/policy/get	principal route rule: user, admin, root	members\policy\Get
ANY	/v1/members/policy/list	principal route rule: user, admin, root	members\policy\ListItems
ANY	/v1/members/policy/save	principal route rule: user, admin, root	members\policy\Save
ANY	/v1/proof/consume	no explicit auth gate detected in route/handler	proof\Consume
ANY	/v1/proof/get	no explicit auth gate detected in route/handler	proof\Get
ANY	/v1/proof/send	no explicit auth gate detected in route/handler	proof\Send
ANY	/v1/proof/verify	no explicit auth gate detected in route/handler	proof\Verify

Endpoints

ANY /hello

Handles hello.

• Handler: thisProject\api\hello\Controller
• Source: lib/php/thisProject/api/hello/Controller.php
• Auth: no explicit auth gate detected in route/handler
• Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
• Response: success comment(s): OK.

ANY /v1/admin/dne/check

Checks dne.

• Handler: thisProject\api\admin\dne\Check
• Source: lib/php/thisProject/api/admin/dne/Check.php
• Delegates to: lib/php/thisProject/service/Dne.php::check
• Auth: principal route rule: admin, root
• Detected request fields:
  • email (required). Email address. Default: ''.
  • group (optional/detected). Group id. Default: ''.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • item (optional/detected). Detected in handler or delegated service code. Default: null.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
• Response: success comment(s): OK; data key(s): found, item.
• Notable errors: Missing email; Invalid email.

ANY /v1/admin/dne/delete

Deletes dne.

• Handler: thisProject\api\admin\dne\Delete
• Source: lib/php/thisProject/api/admin/dne/Delete.php
• Delegates to: lib/php/thisProject/service/Dne.php::check, lib/php/thisProject/service/Dne.php::delete
• Auth: principal route rule: admin, root
• Detected request fields:
  • email (required). Email address. Default: ''.
  • group (optional/detected). Group id. Default: ''.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • item (optional/detected). Detected in handler or delegated service code. Default: null.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
• Response: success comment(s): OK; data key(s): found, item, id, deleted.
• Notable errors: DNE entry not found; Missing email; Invalid email.

ANY /v1/admin/dne/list

Lists dne.

• Handler: thisProject\api\admin\dne\ListItems
• Source: lib/php/thisProject/api/admin/dne/ListItems.php
• Delegates to: lib/php/thisProject/service/Dne.php::listItems
• Auth: principal route rule: admin, root
• Detected request fields:
  • cursor (optional/detected). Opaque pagination cursor.
  • limit (optional/detected). Page size limit. Default: 3.
  • offset (optional/detected). Zero-based pagination offset.
  • page_number (optional/detected). One-based page number.
• Response: success comment(s): OK; data key(s): items, limit, total_count, next_offset, page_number, page_total, next_cursor.
• Notable errors: Invalid offset; Invalid page_number; Invalid email; Invalid domain; Invalid cursor.

ANY /v1/admin/dne/save

Creates or updates dne.

• Handler: thisProject\api\admin\dne\Save
• Source: lib/php/thisProject/api/admin/dne/Save.php
• Delegates to: lib/php/thisProject/service/Dne.php::save
• Auth: principal route rule: admin, root
• Detected request fields:
  • email (required). Email address. Default: ''.
  • group (optional/detected). Group id. Default: ''.
  • metadata (optional/detected). Caller-supplied metadata object. Default: null.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
  • reason (optional/detected). Human-readable reason. Default: null.
  • reason_code (optional/detected). Machine-readable reason code. Default: null.
  • source (optional/detected). Source document/content payload. Default: DneRepository::SOURCE_MANUAL.
  • type (optional/detected). Type discriminator. Default: DneRepository::TYPE_SOFT.
• Response: success comment(s): OK; data key(s): owner, group, email, domain, type, source, reason_code, reason, metadata.
• Notable errors: Missing email; Invalid email domain; Invalid email; Invalid domain.

ANY /v1/admin/domain/delete

Deletes domain.

• Handler: thisProject\api\admin\domain\Delete
• Source: lib/php/thisProject/api/admin/domain/Delete.php
• Delegates to: lib/php/thisProject/service/Domain.php::get, lib/php/thisProject/service/Domain.php::delete
• Auth: principal route rule: admin, root
• Detected request fields:
  • domain (required). Domain name. Default: ''.
  • group (optional/detected). Group id. Default: ''.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
• Response: success comment(s): OK; data key(s): id, deleted, item.
• Notable errors: Domain entry not found; Missing domain; Invalid domain.

ANY /v1/admin/domain/get

Gets domain.

• Handler: thisProject\api\admin\domain\Get
• Source: lib/php/thisProject/api/admin/domain/Get.php
• Delegates to: lib/php/thisProject/service/Domain.php::get
• Auth: principal route rule: admin, root
• Detected request fields:
  • domain (required). Domain name. Default: ''.
  • group (optional/detected). Group id. Default: ''.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
• Response: success comment(s): OK.
• Notable errors: Missing domain; Invalid domain.

ANY /v1/admin/domain/list

Lists domain.

• Handler: thisProject\api\admin\domain\ListItems
• Source: lib/php/thisProject/api/admin/domain/ListItems.php
• Delegates to: lib/php/thisProject/service/Domain.php::listItems
• Auth: principal route rule: admin, root
• Detected request fields:
  • cursor (optional/detected). Opaque pagination cursor.
  • limit (optional/detected). Page size limit. Default: 3.
  • offset (optional/detected). Zero-based pagination offset.
  • page_number (optional/detected). One-based page number.
• Response: success comment(s): OK; data key(s): items, limit, total_count, next_offset, page_number, page_total, next_cursor.
• Notable errors: Invalid offset; Invalid page_number; Invalid domain; Invalid cursor.

ANY /v1/admin/domain/save

Creates or updates domain.

• Handler: thisProject\api\admin\domain\Save
• Source: lib/php/thisProject/api/admin/domain/Save.php
• Delegates to: lib/php/thisProject/service/Domain.php::save
• Auth: principal route rule: admin, root
• Detected request fields:
  • domain (required). Domain name. Default: ''.
  • group (optional/detected). Group id. Default: ''.
  • include_subdomains (optional/detected). Whether child subdomains are included. Default: true.
  • metadata (optional/detected). Caller-supplied metadata object. Default: null.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
  • policy (optional/detected). Policy value. Default: ''.
  • reason (optional/detected). Human-readable reason. Default: null.
  • reason_code (optional/detected). Machine-readable reason code. Default: null.
  • source (optional/detected). Source document/content payload. Default: DomainRepository::SOURCE_MANUAL.
• Response: success comment(s): OK; data key(s): owner, group, domain, policy, include_subdomains, source, reason_code, reason, metadata.
• Notable errors: Missing domain; Invalid policy; Invalid domain.

ANY /v1/admin/health

Returns health for controller.

• Handler: thisProject\api\admin\health\Controller
• Source: lib/php/thisProject/api/admin/health/Controller.php
• Auth: principal route rule: admin, root
• Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
• Response: success comment(s): OK; data key(s): status, message, items.

ANY /v1/admin/job/get

Gets job.

• Handler: thisProject\api\admin\job\Get
• Source: lib/php/thisProject/api/admin/job/Get.php
• Delegates to: lib/php/thisProject/service/job/Controller.php::get
• Auth: principal route rule: admin, root
• Detected request fields:
  • code (optional/detected). One-time code or code id. Default: ''.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
  • status (optional/detected). Status filter or value. Default: ''.
  • value (optional/detected). Detected in handler or delegated service code. Default: ''.
• Response: success comment(s): OK.

ANY /v1/admin/job/list

Lists job.

• Handler: thisProject\api\admin\job\ListItems
• Source: lib/php/thisProject/api/admin/job/ListItems.php
• Delegates to: lib/php/thisProject/service/job/Controller.php::listItems
• Auth: principal route rule: admin, root
• Detected request fields:
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • items (optional/detected). Detected in handler or delegated service code. Default: [].
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
  • status (optional/detected). Status filter or value. Default: ''.
  • value (optional/detected). Detected in handler or delegated service code. Default: ''.
• Response: success comment(s): OK.

ANY /v1/members/job/activate

Activates job.

• Handler: thisProject\api\members\job\Activate
• Source: lib/php/thisProject/api/members/job/Activate.php
• Delegates to: lib/php/thisProject/service/job/Controller.php::activate
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
  • status (optional/detected). Status filter or value. Default: ''.
  • value (optional/detected). Detected in handler or delegated service code. Default: ''.
• Response: success comment(s): OK.

ANY /v1/members/job/cancel

Cancels job.

• Handler: thisProject\api\members\job\Cancel
• Source: lib/php/thisProject/api/members/job/Cancel.php
• Delegates to: lib/php/thisProject/service/job/Controller.php::cancel
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
  • status (optional/detected). Status filter or value. Default: ''.
  • value (optional/detected). Detected in handler or delegated service code. Default: ''.
• Response: success comment(s): OK.

ANY /v1/members/job/create

Creates job.

• Handler: thisProject\api\members\job\Create
• Source: lib/php/thisProject/api/members/job/Create.php
• Delegates to: lib/php/thisProject/service/job/Controller.php::create
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
  • status (optional/detected). Status filter or value. Default: ''.
  • value (optional/detected). Detected in handler or delegated service code. Default: ''.
• Response: success comment(s): OK.

ANY /v1/members/job/get

Gets job.

• Handler: thisProject\api\members\job\Get
• Source: lib/php/thisProject/api/members/job/Get.php
• Delegates to: lib/php/thisProject/service/job/Controller.php::get
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • code (optional/detected). One-time code or code id. Default: ''.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
  • status (optional/detected). Status filter or value. Default: ''.
  • value (optional/detected). Detected in handler or delegated service code. Default: ''.
• Response: success comment(s): OK.

ANY /v1/members/job/list

Lists job.

• Handler: thisProject\api\members\job\ListItems
• Source: lib/php/thisProject/api/members/job/ListItems.php
• Delegates to: lib/php/thisProject/service/job/Controller.php::listItems
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • items (optional/detected). Detected in handler or delegated service code. Default: [].
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
  • status (optional/detected). Status filter or value. Default: ''.
  • value (optional/detected). Detected in handler or delegated service code. Default: ''.
• Response: success comment(s): OK.

ANY /v1/members/job/retry

Retries job.

• Handler: thisProject\api\members\job\Retry
• Source: lib/php/thisProject/api/members/job/Retry.php
• Delegates to: lib/php/thisProject/service/job/Controller.php::retry
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
  • status (optional/detected). Status filter or value. Default: ''.
  • value (optional/detected). Detected in handler or delegated service code. Default: ''.
• Response: success comment(s): OK.

ANY /v1/members/message/group/delete

Deletes message group.

• Handler: thisProject\api\members\message\group\Delete
• Source: lib/php/thisProject/api/members/message/group/Delete.php
• Delegates to: lib/php/thisProject/service/MessageGroup.php::delete
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • name (required). Name field. Default: ''.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • message_template (optional/detected). Message template id. Default: ''.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
  • policy_group (optional/detected). Detected in handler or delegated service code. Default: self::ZERO_UUID.
• Response: success comment(s): OK; data key(s): id, deleted, item.
• Notable errors: Message group not found; Missing message group lookup fields; Missing name.

ANY /v1/members/message/group/get

Gets message group.

• Handler: thisProject\api\members\message\group\Get
• Source: lib/php/thisProject/api/members/message/group/Get.php
• Delegates to: lib/php/thisProject/service/MessageGroup.php::get
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • name (required). Name field. Default: ''.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • message_template (optional/detected). Message template id. Default: ''.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
  • policy_group (optional/detected). Detected in handler or delegated service code. Default: self::ZERO_UUID.
• Response: success comment(s): OK.
• Notable errors: Message group not found; Missing message group lookup fields; Missing name.

ANY /v1/members/message/group/list

Lists message group.

• Handler: thisProject\api\members\message\group\ListItems
• Source: lib/php/thisProject/api/members/message/group/ListItems.php
• Delegates to: lib/php/thisProject/service/MessageGroup.php::listItems
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • cursor (optional/detected). Opaque pagination cursor.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • limit (optional/detected). Page size limit. Default: 3.
  • message_template (optional/detected). Message template id. Default: ''.
  • offset (optional/detected). Zero-based pagination offset.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
  • page_number (optional/detected). One-based page number.
  • policy_group (optional/detected). Detected in handler or delegated service code. Default: self::ZERO_UUID.
• Response: success comment(s): OK; data key(s): items, limit, total_count, next_offset, page_number, page_total, next_cursor.
• Notable errors: Invalid offset; Invalid page_number; Invalid cursor.

ANY /v1/members/message/group/save

Creates or updates message group.

• Handler: thisProject\api\members\message\group\Save
• Source: lib/php/thisProject/api/members/message/group/Save.php
• Delegates to: lib/php/thisProject/service/MessageGroup.php::save
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • label (required). Display label. Default: ''.
  • name (required). Name field. Default: ''.
  • description (optional/detected). Description text. Default: null.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • message_template (optional/detected). Message template id. Default: ''.
  • metadata (optional/detected). Caller-supplied metadata object. Default: null.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
  • policy_group (optional/detected). Detected in handler or delegated service code. Default: ''.
• Response: success comment(s): OK; data key(s): owner, name, label, description, policy_group, metadata.
• Notable errors: Message group not found; Missing message group lookup fields; Policy group not found; Policy group is not available for this owner; Missing name; Missing label.

ANY /v1/members/message/group/template/delete

Deletes message group template.

• Handler: thisProject\api\members\message\group\template\Delete
• Source: lib/php/thisProject/api/members/message/group/template/Delete.php
• Delegates to: lib/php/thisProject/service/MessageGroupTemplate.php::delete
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • message_group (optional/detected). Message group id. Default: ''.
  • message_template (optional/detected). Message template id. Default: ''.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
• Response: success comment(s): OK; data key(s): id, deleted, item.
• Notable errors: Message group template link not found; Missing message group template lookup fields; Message group not found; Message template not found.

ANY /v1/members/message/group/template/get

Gets message group template.

• Handler: thisProject\api\members\message\group\template\Get
• Source: lib/php/thisProject/api/members/message/group/template/Get.php
• Delegates to: lib/php/thisProject/service/MessageGroupTemplate.php::get
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • message_group (optional/detected). Message group id. Default: ''.
  • message_template (optional/detected). Message template id. Default: ''.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
• Response: success comment(s): OK.
• Notable errors: Message group template link not found; Missing message group template lookup fields; Message group not found; Message template not found.

ANY /v1/members/message/group/template/list

Lists message group template.

• Handler: thisProject\api\members\message\group\template\ListItems
• Source: lib/php/thisProject/api/members/message/group/template/ListItems.php
• Delegates to: lib/php/thisProject/service/MessageGroupTemplate.php::listItems
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • cursor (optional/detected). Opaque pagination cursor.
  • limit (optional/detected). Page size limit. Default: 3.
  • message_group (optional/detected). Message group id. Default: ''.
  • message_template (optional/detected). Message template id. Default: ''.
  • offset (optional/detected). Zero-based pagination offset.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
  • page_number (optional/detected). One-based page number.
• Response: success comment(s): OK; data key(s): items, limit, total_count, next_offset, page_number, page_total, next_cursor.
• Notable errors: Message group not found; Invalid offset; Invalid page_number; Invalid cursor.

ANY /v1/members/message/group/template/save

Creates or updates message group template.

• Handler: thisProject\api\members\message\group\template\Save
• Source: lib/php/thisProject/api/members/message/group/template/Save.php
• Delegates to: lib/php/thisProject/service/MessageGroupTemplate.php::save
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • message_group (optional/detected). Message group id. Default: ''.
  • message_template (optional/detected). Message template id. Default: ''.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
• Response: success comment(s): OK.
• Notable errors: Message group not found; Message template not found.

ANY /v1/members/message/template/delete

Deletes message template.

• Handler: thisProject\api\members\message\template\Delete
• Source: lib/php/thisProject/api/members/message/template/Delete.php
• Delegates to: lib/php/thisProject/service/MessageTemplate.php::delete
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • name (required). Name field. Default: ''.
  • channel (optional/detected). Delivery/proof channel. Default: ''.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • message_group (optional/detected). Message group id. Default: ''.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
• Response: success comment(s): OK; data key(s): id, deleted, item.
• Notable errors: Message template not found; Missing message template lookup fields; Missing name; Invalid channel.

ANY /v1/members/message/template/get

Gets message template.

• Handler: thisProject\api\members\message\template\Get
• Source: lib/php/thisProject/api/members/message/template/Get.php
• Delegates to: lib/php/thisProject/service/MessageTemplate.php::get
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • name (required). Name field. Default: ''.
  • channel (optional/detected). Delivery/proof channel. Default: ''.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • message_group (optional/detected). Message group id. Default: ''.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
• Response: success comment(s): OK.
• Notable errors: Message template not found; Missing message template lookup fields; Missing name; Invalid channel.

ANY /v1/members/message/template/list

Lists message template.

• Handler: thisProject\api\members\message\template\ListItems
• Source: lib/php/thisProject/api/members/message/template/ListItems.php
• Delegates to: lib/php/thisProject/service/MessageTemplate.php::listItems
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • cursor (optional/detected). Opaque pagination cursor.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • limit (optional/detected). Page size limit. Default: 3.
  • message_group (optional/detected). Message group id. Default: ''.
  • offset (optional/detected). Zero-based pagination offset.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
  • page_number (optional/detected). One-based page number.
• Response: success comment(s): OK; data key(s): items, limit, total_count, next_offset, page_number, page_total, next_cursor.
• Notable errors: Invalid offset; Invalid page_number; Invalid channel; Invalid status; Invalid cursor.

ANY /v1/members/message/template/save

Creates or updates message template.

• Handler: thisProject\api\members\message\template\Save
• Source: lib/php/thisProject/api/members/message/template/Save.php
• Delegates to: lib/php/thisProject/service/MessageTemplate.php::save
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • body_text (required). Plain-text message body. Default: ''.
  • label (required). Display label. Default: ''.
  • name (required). Name field. Default: ''.
  • body_html (optional/detected). HTML message body. Default: null.
  • channel (optional/detected). Delivery/proof channel. Default: ''.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • is_default (optional/detected). Detected in handler or delegated service code. Default: false.
  • message_group (optional/detected). Message group id. Default: ''.
  • metadata (optional/detected). Caller-supplied metadata object. Default: null.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
  • status (optional/detected). Status filter or value. Default: MessageTemplateTable::STATUS_ACTIVE.
  • subject (optional/detected). Message subject. Default: null.
• Response: success comment(s): OK; data key(s): owner, channel, name, label, status, is_default, subject, body_text, body_html, metadata.
• Notable errors: Message template not found; Missing message template lookup fields; Missing name; Missing label; Missing body_text; Invalid channel.

ANY /v1/members/policy/delete

Deletes policy.

• Handler: thisProject\api\members\policy\Delete
• Source: lib/php/thisProject/api/members/policy/Delete.php
• Delegates to: lib/php/thisProject/service/PolicyGroup.php::delete
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • name (required). Name field. Default: ''.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
• Response: success comment(s): OK; data key(s): id, deleted, item.
• Notable errors: Policy group not found; Missing policy group lookup fields; Missing name.

ANY /v1/members/policy/dne/check

Checks policy dne.

• Handler: thisProject\api\members\policy\dne\Check
• Source: lib/php/thisProject/api/members/policy/dne/Check.php
• Delegates to: lib/php/thisProject/service/Dne.php::check
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • email (required). Email address. Default: ''.
  • group (optional/detected). Group id. Default: ''.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
• Response: success comment(s): OK; data key(s): found, item.
• Notable errors: Missing email; Invalid email.

ANY /v1/members/policy/dne/delete

Deletes policy dne.

• Handler: thisProject\api\members\policy\dne\Delete
• Source: lib/php/thisProject/api/members/policy/dne/Delete.php
• Delegates to: lib/php/thisProject/service/Dne.php::delete
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • email (required). Email address. Default: ''.
  • group (optional/detected). Group id. Default: ''.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
• Response: success comment(s): OK; data key(s): id, deleted, item.
• Notable errors: DNE entry not found; Missing email; Invalid email.

ANY /v1/members/policy/dne/get

Gets policy dne.

• Handler: thisProject\api\members\policy\dne\Get
• Source: lib/php/thisProject/api/members/policy/dne/Get.php
• Delegates to: lib/php/thisProject/service/Dne.php::check
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • email (required). Email address. Default: ''.
  • group (optional/detected). Group id. Default: ''.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
• Response: success comment(s): OK; data key(s): found, item.
• Notable errors: Missing email; Invalid email.

ANY /v1/members/policy/dne/list

Lists policy dne.

• Handler: thisProject\api\members\policy\dne\ListItems
• Source: lib/php/thisProject/api/members/policy/dne/ListItems.php
• Delegates to: lib/php/thisProject/service/Dne.php::listItems
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • cursor (optional/detected). Opaque pagination cursor.
  • limit (optional/detected). Page size limit. Default: 3.
  • offset (optional/detected). Zero-based pagination offset.
  • page_number (optional/detected). One-based page number.
• Response: success comment(s): OK; data key(s): items, limit, total_count, next_offset, page_number, page_total, next_cursor.
• Notable errors: Invalid offset; Invalid page_number; Invalid email; Invalid domain; Invalid cursor.

ANY /v1/members/policy/dne/save

Creates or updates policy dne.

• Handler: thisProject\api\members\policy\dne\Save
• Source: lib/php/thisProject/api/members/policy/dne/Save.php
• Delegates to: lib/php/thisProject/service/Dne.php::save
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • email (required). Email address. Default: ''.
  • group (optional/detected). Group id. Default: ''.
  • metadata (optional/detected). Caller-supplied metadata object. Default: null.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
  • reason (optional/detected). Human-readable reason. Default: null.
  • reason_code (optional/detected). Machine-readable reason code. Default: null.
  • source (optional/detected). Source document/content payload. Default: DneRepository::SOURCE_MANUAL.
  • type (optional/detected). Type discriminator. Default: DneRepository::TYPE_SOFT.
• Response: success comment(s): OK; data key(s): owner, group, email, domain, type, source, reason_code, reason, metadata.
• Notable errors: Missing email; Invalid email domain; Invalid email; Invalid domain.

ANY /v1/members/policy/domain/check

Checks policy domain.

• Handler: thisProject\api\members\policy\domain\Check
• Source: lib/php/thisProject/api/members/policy/domain/Check.php
• Delegates to: lib/php/thisProject/service/Domain.php::get
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • domain (required). Domain name. Default: ''.
  • group (optional/detected). Group id. Default: ''.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
• Response: success comment(s): OK.
• Notable errors: Missing domain; Invalid domain.

ANY /v1/members/policy/domain/delete

Deletes policy domain.

• Handler: thisProject\api\members\policy\domain\Delete
• Source: lib/php/thisProject/api/members/policy/domain/Delete.php
• Delegates to: lib/php/thisProject/service/Domain.php::delete
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • domain (required). Domain name. Default: ''.
  • group (optional/detected). Group id. Default: ''.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
• Response: success comment(s): OK; data key(s): id, deleted, item.
• Notable errors: Domain entry not found; Missing domain; Invalid domain.

ANY /v1/members/policy/domain/get

Gets policy domain.

• Handler: thisProject\api\members\policy\domain\Get
• Source: lib/php/thisProject/api/members/policy/domain/Get.php
• Delegates to: lib/php/thisProject/service/Domain.php::get
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • domain (required). Domain name. Default: ''.
  • group (optional/detected). Group id. Default: ''.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
• Response: success comment(s): OK.
• Notable errors: Missing domain; Invalid domain.

ANY /v1/members/policy/domain/list

Lists policy domain.

• Handler: thisProject\api\members\policy\domain\ListItems
• Source: lib/php/thisProject/api/members/policy/domain/ListItems.php
• Delegates to: lib/php/thisProject/service/Domain.php::listItems
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • cursor (optional/detected). Opaque pagination cursor.
  • limit (optional/detected). Page size limit. Default: 3.
  • offset (optional/detected). Zero-based pagination offset.
  • page_number (optional/detected). One-based page number.
• Response: success comment(s): OK; data key(s): items, limit, total_count, next_offset, page_number, page_total, next_cursor.
• Notable errors: Invalid offset; Invalid page_number; Invalid domain; Invalid cursor.

ANY /v1/members/policy/domain/save

Creates or updates policy domain.

• Handler: thisProject\api\members\policy\domain\Save
• Source: lib/php/thisProject/api/members/policy/domain/Save.php
• Delegates to: lib/php/thisProject/service/Domain.php::save
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • domain (required). Domain name. Default: ''.
  • group (optional/detected). Group id. Default: ''.
  • include_subdomains (optional/detected). Whether child subdomains are included. Default: true.
  • metadata (optional/detected). Caller-supplied metadata object. Default: null.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
  • policy (optional/detected). Policy value. Default: ''.
  • reason (optional/detected). Human-readable reason. Default: null.
  • reason_code (optional/detected). Machine-readable reason code. Default: null.
  • source (optional/detected). Source document/content payload. Default: DomainRepository::SOURCE_MANUAL.
• Response: success comment(s): OK; data key(s): owner, group, domain, policy, include_subdomains, source, reason_code, reason, metadata.
• Notable errors: Missing domain; Invalid policy; Invalid domain.

ANY /v1/members/policy/get

Gets policy.

• Handler: thisProject\api\members\policy\Get
• Source: lib/php/thisProject/api/members/policy/Get.php
• Delegates to: lib/php/thisProject/service/PolicyGroup.php::get
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • name (required). Name field. Default: ''.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
• Response: success comment(s): OK.
• Notable errors: Policy group not found; Missing policy group lookup fields; Missing name.

ANY /v1/members/policy/list

Lists policy.

• Handler: thisProject\api\members\policy\ListItems
• Source: lib/php/thisProject/api/members/policy/ListItems.php
• Delegates to: lib/php/thisProject/service/PolicyGroup.php::listItems
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • cursor (optional/detected). Opaque pagination cursor.
  • limit (optional/detected). Page size limit. Default: 3.
  • offset (optional/detected). Zero-based pagination offset.
  • page_number (optional/detected). One-based page number.
• Response: success comment(s): OK; data key(s): items, limit, total_count, next_offset, page_number, page_total, next_cursor.
• Notable errors: Invalid offset; Invalid page_number; Invalid cursor.

ANY /v1/members/policy/save

Creates or updates policy.

• Handler: thisProject\api\members\policy\Save
• Source: lib/php/thisProject/api/members/policy/Save.php
• Delegates to: lib/php/thisProject/service/PolicyGroup.php::save
• Auth: principal route rule: user, admin, root
• Detected request fields:
  • name (required). Name field. Default: ''.
  • description (optional/detected). Description text. Default: null.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • metadata (optional/detected). Caller-supplied metadata object. Default: null.
  • owner (optional/detected). Owner principal/user id. Usually inferred from the authenticated principal for member routes. Default: ''.
• Response: success comment(s): OK; data key(s): owner, name, description, metadata.
• Notable errors: Policy group not found; Missing policy group lookup fields; Missing name.

ANY /v1/proof/consume

Consumes proof.

• Handler: thisProject\api\proof\Consume
• Source: lib/php/thisProject/api/proof/Consume.php
• Delegates to: lib/php/thisProject/service/Proof.php::consume
• Auth: no explicit auth gate detected in route/handler
• Detected request fields:
  • job (required). Job id or job reference. Default: ''.
  • code (optional/detected). One-time code or code id. Default: ''.
  • consumed_at (optional/detected). Detected in handler or delegated service code. Default: null.
  • email (optional/detected). Email address. Default: ''.
  • expires_at (optional/detected). Expiration timestamp. Default: null.
  • failed_attempt_count (optional/detected). Detected in handler or delegated service code. Default: 0.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: null.
  • item (optional/detected). Detected in handler or delegated service code. Default: [].
  • kind (optional/detected). Type/kind discriminator. Default: ''.
  • last_failed_at (optional/detected). Detected in handler or delegated service code. Default: null.
  • metadata (optional/detected). Caller-supplied metadata object. Default: [].
  • proof_policy (optional/detected). Proof policy value. Default: ''.
  • secret_hash (optional/detected). Detected in handler or delegated service code. Default: null.
  • status (optional/detected). Status filter or value. Default: ''.
  • token (optional/detected). Token value. Default: ''.
  • type (optional/detected). Type discriminator. Default: ''.
  • value (optional/detected). Detected in handler or delegated service code. Default: ''.
  • verified_at (optional/detected). Detected in handler or delegated service code. Default: null.
• Response: success comment(s): OK.
• Notable errors: Job is not active; Invalid proof_policy; Invalid kind; Proof challenge is not armed; Method not found; Missing secret; Job not found; Only email proof delivery is currently implemented.

ANY /v1/proof/get

Gets proof.

• Handler: thisProject\api\proof\Get
• Source: lib/php/thisProject/api/proof/Get.php
• Delegates to: lib/php/thisProject/service/Proof.php::get
• Auth: no explicit auth gate detected in route/handler
• Detected request fields:
  • job (required). Job id or job reference. Default: ''.
  • job_id (required). Job id. Some handlers also accept id as an alias. Default: ''.
  • code (optional/detected). One-time code or code id. Default: ''.
  • email (optional/detected). Email address. Default: ''.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • kind (optional/detected). Type/kind discriminator. Default: ''.
  • last_used_at (optional/detected). Detected in handler or delegated service code. Default: null.
  • metadata (optional/detected). Caller-supplied metadata object. Default: [].
  • priority (optional/detected). Detected in handler or delegated service code. Default: 0.
  • proof_policy (optional/detected). Proof policy value. Default: ''.
  • status (optional/detected). Status filter or value. Default: ''.
  • token (optional/detected). Token value. Default: ''.
  • type (optional/detected). Type discriminator. Default: ''.
  • value (optional/detected). Detected in handler or delegated service code. Default: ''.
  • verified_at (optional/detected). Detected in handler or delegated service code. Default: null.
• Response: success comment(s): OK; data key(s): id, type, masked, status, priority, verified_at, last_used_at, current.
• Notable errors: Job is not active; Invalid proof_policy; Invalid kind; Proof challenge is not armed; Method not found; Job not found; Only email proof delivery is currently implemented; Invalid job.

ANY /v1/proof/send

Sends proof.

• Handler: thisProject\api\proof\Send
• Source: lib/php/thisProject/api/proof/Send.php
• Delegates to: lib/php/thisProject/service/Proof.php::send
• Auth: no explicit auth gate detected in route/handler
• Detected request fields:
  • job (required). Job id or job reference. Default: ''.
  • job_id (required). Job id. Some handlers also accept id as an alias. Default: ''.
  • method (required). Method selector or delivery method.
  • method_id (required). Detected in handler or delegated service code. Default: ''.
  • code (optional/detected). One-time code or code id. Default: ''.
  • consumed_at (optional/detected). Detected in handler or delegated service code. Default: null.
  • expires_at (optional/detected). Expiration timestamp. Default: null.
  • failed_attempt_count (optional/detected). Detected in handler or delegated service code. Default: 0.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
  • kind (optional/detected). Type/kind discriminator. Default: ''.
  • last_failed_at (optional/detected). Detected in handler or delegated service code. Default: null.
  • metadata (optional/detected). Caller-supplied metadata object. Default: null.
  • noop (optional/detected). Detected in handler or delegated service code. Default: false.
  • proof_policy (optional/detected). Proof policy value. Default: ''.
  • secret_hash (optional/detected). Detected in handler or delegated service code. Default: null.
  • status (optional/detected). Status filter or value. Default: ''.
  • success (optional/detected). Detected in handler or delegated service code. Default: false.
  • token (optional/detected). Token value. Default: ''.
  • type (optional/detected). Type discriminator. Default: ''.
  • value (optional/detected). Detected in handler or delegated service code. Default: ''.
  • verified_at (optional/detected). Detected in handler or delegated service code. Default: null.
• Response: success comment(s): OK; data key(s): armed, credential, delivery, request, item, issued, success, method, noop.
• Notable errors: Job is not active; Invalid proof_policy; Forced secret is not allowed on send; Missing method_id; Invalid method_id; Method not found; Method is not available for this job; Method is not currently eligible for this job.

ANY /v1/proof/verify

Verifies proof.

• Handler: thisProject\api\proof\Verify
• Source: lib/php/thisProject/api/proof/Verify.php
• Delegates to: lib/php/thisProject/service/Proof.php::verify
• Auth: no explicit auth gate detected in route/handler
• Detected request fields:
  • job (required). Job id or job reference. Default: ''.
  • code (optional/detected). One-time code or code id. Default: ''.
  • email (optional/detected). Email address. Default: ''.
  • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: null.
  • item (optional/detected). Detected in handler or delegated service code. Default: null.
  • kind (optional/detected). Type/kind discriminator. Default: ''.
  • metadata (optional/detected). Caller-supplied metadata object. Default: [].
  • proof_policy (optional/detected). Proof policy value. Default: ''.
  • status (optional/detected). Status filter or value. Default: ''.
  • token (optional/detected). Token value. Default: ''.
  • type (optional/detected). Type discriminator. Default: ''.
  • value (optional/detected). Detected in handler or delegated service code. Default: ''.
• Response: success comment(s): OK.
• Notable errors: Job is not active; Invalid proof_policy; Invalid kind; Proof challenge is not armed; Method not found; Missing secret; Job not found; Only email proof delivery is currently implemented.