Forms

Update Form Registry

Rename a form, reassign its owner, or archive it.

patch/forms/{form_key}

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/forms/{form_key}
  • Auth: HTTP bearer

Path parameters

form_keystring required

Form key.

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

source_idstring required

Which INSTALLED SOURCE of this form. A form key can be present on more than one source, and every operation on this surface is scoped to one - omitting it would silently act on whichever the backend picked.

display_namestring nullable
owner_idstring nullable
archivedboolean nullable

Archive or unarchive. Omit to leave unchanged.

Response

Successful Response

dataFormPayload required

An open envelope for a form operational view.

overview, fields, placements, activity, a route save result and a submission trace each return a different shape assembled from several upstreams. Pinning any of them would drop a field the moment one is added, and on a delivery-diagnostics surface a missing field reads as a missing delivery.

Changes

No recorded changes to this operation across all 2 revisions of this API.