PublicFormRequestUpdate

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/dottedsign-com/json-schema/dottedsign-com-public-form-request-update-schema.json",
  "title": "PublicFormRequestUpdate",
  "description": "Public form update.",
  "x-generated": "2026-11-06",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/dottedsign-com-publicforms-api-openapi.yml#/components/schemas/PublicFormRequestUpdate",
  "type": "object",
  "required": [
    "form_id"
  ],
  "properties": {
    "form_id": {
      "type": "integer",
      "description": "Form ID."
    },
    "form_name": {
      "type": "string",
      "description": "Form name.",
      "pattern": "^(?!.*[\\\"*:<>\\?\\/\\\\|~#%&{}])[^.].*$",
      "maxLength": 255
    },
    "description": {
      "type": "string",
      "description": "Form description.",
      "maxLength": 500
    },
    "goal_num": {
      "type": "integer",
      "description": "The number of task required to complete the form. If `-1`, then the form is not limited by the number of tasks.",
      "default": -1
    },
    "end_at": {
      "type": "integer",
      "description": "Form ended up timestamp."
    },
    "signer_infos": {
      "type": "array",
      "description": "Form stage signers info. The number of stages should be equal to the number of the used template.",
      "items": {
        "$ref": "#/$defs/PublicFormRequestSignerInfo"
      }
    },
    "metadata": {
      "type": "object",
      "description": "Metadata. **Maximum 10 key-value pairs, where each key length must be less than or equal to 40 characters and each value length must be less than or equal to 100 characters.**"
    }
  },
  "$defs": {
    "PublicFormRequestSignerInfo": {
      "type": "object",
      "required": [
        "signer_type"
      ],
      "properties": {
        "signer_type": {
          "type": "string",
          "description": "Specifies the type of signer in the form stage:\n- `form_signer`: an unspecified user who only needs to provide basic information like name or email when signing\n- `normal_signer`: a designated user\n\nThe first signer in the sequence must be a `form_signer`, and all `normal_signer`s must follow after all `form_signer`s.\n",
          "enum": [
            "form_signer",
            "normal_signer"
          ]
        },
        "name": {
          "type": "string",
          "description": "Form stage signer name. *Required if `signer_type` is `normal_signer`.*"
        },
        "email": {
          "type": "string",
          "description": "Form stage signer email. *Required if `signer_type` is `normal_signer`.*",
          "maxLength": 250
        },
        "phone": {
          "type": "string",
          "description": "Form stage signer phone (area code + number). *Required if `signer_type` is `normal_signer`, and the used template requires SMS OTP.*"
        },
        "requisite": {
          "$ref": "#/$defs/PublicFormSignerInfoRequisite"
        }
      },
      "description": "Public form request body - signer info."
    },
    "PublicFormSignerInfoRequisite": {
      "type": "object",
      "description": "Public form signer info - requisite.",
      "properties": {
        "name": {
          "type": "string",
          "description": "Signer should provide his name or not.",
          "enum": [
            "required",
            "optional"
          ]
        },
        "email": {
          "type": "string",
          "description": "Signer should provide his email or not.",
          "enum": [
            "required"
          ]
        }
      }
    }
  }
}