forms/{post}/{form}/settings REST endpoint
Submit a published form or read and save its private action settings.
Endpoint#
Submit a published form or read and save its private action settings.
/wp-json/cantata-edit/v1/forms/(?P<post>\d+)/(?P<form>[a-z0-9-]{1,40})/settings
Named regular-expression groups in this registered route are path parameters. Replace them with an actual matching value when constructing a request.
GET#
This operation uses a server permission callback. Browser clients need an authenticated WordPress session and REST nonce. The server checks the relevant caller capability and feature gates.
Permission expression in this release:
'permission_callback' => static fn( WP_REST_Request $r ) => current_user_can( 'edit_post', (int) $r['post'] ),
Registered argument schema#
[]
An empty schema means the route did not declare arguments in its registration. It does not mean that the callback accepts arbitrary data or has no required body fields. Callback-level validation remains authoritative.
Callback input keys#
form, post. This literal-key inventory supplements the registered schema; nested objects and downstream validators can define additional structure.
Implementation#
POST#
This operation uses a server permission callback. Browser clients need an authenticated WordPress session and REST nonce. The server checks the relevant caller capability and feature gates.
Permission expression in this release:
'permission_callback' => static fn( WP_REST_Request $r ) => current_user_can( 'edit_post', (int) $r['post'] ),
Registered argument schema#
[]
An empty schema means the route did not declare arguments in its registration. It does not mean that the callback accepts arbitrary data or has no required body fields. Callback-level validation remains authoritative.
Callback input keys#
form, post. This literal-key inventory supplements the registered schema; nested objects and downstream validators can define additional structure.
Implementation#
Client handling#
Use HTTPS on production sites. Treat authentication failures, validation errors, missing records, and stale-revision conflicts as different outcomes. Read the returned WordPress error code and message. Before retrying a timed-out mutation, determine whether the first request succeeded. Prefer the documented higher-level editor or Ability workflow when an endpoint coordinates several metadata owners.