Nodes

Update a node

Updates a node.

patch/forms/{formId}/nodes/{nodeId}

Request

  • Base URL: https://api.clipform.io/v1
  • URL: https://api.clipform.io/v1/forms/{formId}/nodes/{nodeId}
  • Auth: HTTP bearer

Path parameters

formIdstring uuid required
nodeIdstring uuid required

Request body

promptstring
type'choice' | 'open' | 'button' | 'details' | 'payment' | 'file_download' | 'redirect' | 'end_screen'
requiredboolean
public_results_hiddenboolean

Hide this node's data from the public results portal without affecting the owner Results tab.

configobject

Type-specific configuration, merged shallowly into the stored config. A null value deletes that key; nested objects are replaced wholesale. When type is changed in the same request, config replaces the stored configuration instead of merging.

Response

Node updated

node_idstring uuid
warningsstring[]

Advisory notices, returned only when present - e.g. scored options were written to a node whose choice.record_scores is explicitly false.

Changes

No recorded changes to this operation across all 1 revision of this API.