docs: document change_state and list_states endpoints - #34
Merged
Merged
Conversation
Both endpoints were already available in the external API and are what the Change Form Status action of the Zapier and Power Automate connectors calls, but they were missing from this reference. Adds Get Answer Statuses and Change Answer Status to the Answers section, including the name-only lookup of form_name, the side effects of a status change (history, status webhooks, push notification) and the fact that list_states is not filtered by the deleted flag. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
change_stateandlist_stateshave been live in the external API for a long time, and they are what the Change Form Status action of the Zapier and Power Automate connectors calls, but neither was in this reference. Anyone integrating without those connectors had no way to find them.What changed
Two new subsections in Answers, right after Change Answer:
GET/POST /api/external/list_states) — no parameters, returnstype/key/identifier, plus a note that a status deleted in the web app is still listed because the response is not filtered by thedeletedflag (the Answers endpoints report-for those instead).POST/GET /api/external/change_state) —form_name,form_codeandform_state_id, all required. Documents thatform_nameaccepts the form's name only and not its ID, that the most recent form wins when two share a name, the side effects of the change (history entry, status-change webhooks, push notification when the account has it enabled), and that a400comes back with an empty body for any of the three failed lookups.Plus the
10-Sep-2026changelog entry.Base is
main, since that is where the documentation is maintained.Notes
### HTTP Request,### Input Parameter,### Response Fields,### Return Codes).apiDefinition.swagger.jsondeclareskeyon/list_statesasstring, while the backend returns an integer. Left untouched.🤖 Generated with Claude Code