asksteps: publish a form, or get the link to publish it
asksteps_publish_formPublishes a form or funnel — or, when the account has not authorised an agent to publish, returns the link where the user does it themselves. Requires "publish:write". Read the status: "confirmation_required" means NOTHING happened and you should hand over the url; "input_required" means you must ask the user for the fields listed in "missing" and call again; "published" means it is live at the returned url. NEVER invent a slug — it becomes a public address that stays in circulation. Ask the user. Publishing puts the form on the open internet, with the legal obligations that come with a public page; say so before you ask. Taking a form offline (publish = false) always works and needs no mandate.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| slug | No | The path the form should live at, e.g. "kontakt". Ask the user; never make one up. | |
| target | No | Where to publish: "page" (a page on the asksteps platform, the usual choice) or "whitelabel" (the customer's own subdomain or domain). Defaults to "page". | |
| confirm | No | Set to true only AFTER the user has explicitly agreed. Without it nothing is switched. | |
| form_id | Yes | The form or funnel id. | |
| publish | No | true to publish (default), false to take it offline again. | |
| visibility | No | Who may find it: "public" (listed and indexable), "unlisted" (only via the link) or "password". Ask the user. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | The public address of the form once it is live, or the link where the user confirms the publication themselves. | |
| note | Yes | One sentence for the user. On "confirmation_required" make clear that nothing has been published yet. | |
| status | Yes | Outcome. One of: "published" (it is live now), "unpublished" (taken offline), "input_required" (the mandate is there but something is missing — see missing), "confirmation_required" (no mandate: give the user the url and let them do it), "not_connected", "not_found", "not_allowed" (the mandate does not cover this channel), "error". Authorisation can also refuse before the tool runs: "plan_required" (the account's plan does not include agent access), "not_enabled" (the account owner has not switched agent access on), "owner_required" (only the account owner may do this), "mandate_required" (the owner has not granted a mandate for this). The note then says what the user has to do. | |
| target | No | The channel this answer is about: "page" (a page on the asksteps platform) or "whitelabel" (the customer's own subdomain or domain). | |
| missing | No | The parameters you still have to supply, by name. Ask the user for each of them and call again with all of them plus confirm = true. Never invent a slug — it becomes a public address that stays in circulation. |