Sign in

v1

latestOpenAPI 3.0.22026-07-146168117.0 KB
Forms

This endpoint updates a specific form by slug or ID. Please note that this feature is exclusively available as part of the Business API.

put/forms/{slug_or_id}

Path parameters

slug_or_idstring required

The form's slug, custom slug or ID.

Request body

titlestring nullable

The title of the form.

descriptionstring nullable

The description of the form.

disabledboolean

Whether the form is disabled.

custom_slugstring nullable

The custom slug of the form.

space_idstring nullable

The ID of the space to move the form into. Must be a valid space accessible to the user.

translation_idstring nullable

The ID of the translation to use on this form. Must be a valid translation accessible to the user. Setting to null will use the default account translation (English).

Example request

{
  "title": "My Form",
  "description": "This is my form",
  "custom_slug": "my-form",
  "space_id": "5d40fdaf174b4c0007043072",
  "translation_id": "5d40fdaf174b4c0007043072"
}

Response

Successfully updated a single form that matched the provided slug or ID

status'ok'

Example response

{
  "results": {
    "form": {
      "id": "5d40fdaf174b4c0007043072",
      "slug": "67fqxwkp",
      "custom_slug": "my-form-slug",
      "title": "My Form Title",
      "description": "This is a description for my form",
      "cover_image_url": "https://s3-ap-southeast-2.amazonaws.com/paperform/u-22714/1/2019-04-14/58p3u6p/cabinet-clothes-clothes-hanger-996329.jpg",
      "url": "https://lffa4fxo.paperform.co",
      "live": true,
      "submission_count": 50,
      "created_at": "2019-04-14T09:00:00.000Z",
      "updated_at": "2019-04-14T09:00:00.000Z",
      "account_timezone": "Australia/Sydney",
      "created_at_utc": "2019-04-14T09:00:00.000Z",
      "updated_at_utc": "2019-04-14T09:00:00.000Z"
    }
  }
}