Update a form title, settings, or fields

Update form title, settings, or fields. Add a field by omitting its id. op add also inserts a field and must not include an id. Remove a field with op remove or removeFieldIds. New field ids are returned on added. Requires a browser session or an org API key with forms:write. A missing or wrong key is 404, not 401. An org API key shares 60 updates per organization per hour with MCP, including adds and removes. A website session is not counted. A field id that is not on the current draft is 409. A field whose key has answers or consents on any version of the form cannot be removed. A field key that already has answers or consents cannot be changed. Help text is at most 2000 characters.

patch/api/v1/forms/{id}

Request

  • Base URL: https://applytovolunteer.com
  • URL: https://applytovolunteer.com/api/v1/forms/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Form id.

Request body

titlestring

Form title, at most 200 characters. On a published form this is held as a draft until publish.

removeFieldIdsstring[]

Field ids to delete from the current draft. A field whose key has answers or consents on any version of this form is 409. A field id that is not on the draft is 409. A malformed id is 400. Combined with op remove, at most 20 deletes per call.

Response

Update form title, settings, or fields. Add a field by omitting its id. op add also inserts a field and must not include an id. Remove a field with op remove or removeFieldIds. New field ids are returned on added.

Changes

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