Form replies

Turn reply capture on or off for one form

Nippy captures forms that look like a way to contact you and leaves the rest alone. That is a default, not a decision — use this to correct it in either direction.

patch/sites/{siteId}/forms/{formId}/capture

Request

  • Base URL: https://api.nippy.host
  • URL: https://api.nippy.host/sites/{siteId}/forms/{formId}/capture
  • Auth: bearer (a scheme the document does not define)

Path parameters

siteIdstring required

Site UUID

formIdstring required

Form UUID

Request body

captureEnabledboolean required

When true, replies to this form are stored. When false they are discarded at ingest — nothing is kept and nothing is counted.

Response

idstring required

Form UUID

siteIdstring required

Site UUID this form belongs to

namestring required

Display name — derived from a nearby heading or the page path, or set by the owner.

pagePathstring required

Path of the page the form appears on

fieldLabelsstring[] required

Field labels as last seen, in the order they appear.

captureEnabledboolean required

Whether replies to this form are stored. Defaults to whether the form looks like a way to contact the owner; the owner decides from then on.

notifyEveryReplyboolean required

Whether the owner asked to be emailed about every reply to this form, not just the first. Paid plans only; replies are saved on every plan.

submissionCountnumber required

Number of replies stored for this form

lastSubmissionAtstring nullable required

ISO timestamp of the most recent reply, or null

supersedesFormIdstring nullable required

When this form replaced an earlier one whose fields differed, the id of that earlier form. Its replies are still stored against it; merging is offered rather than done automatically, because the match is a heuristic and a merge cannot be undone. Null when there is nothing to merge.

createdAtstring required

ISO timestamp the form was first seen

Changes

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