Zapier · Schema

InputField

Represents Input Field data as accepted by the API

IntegrationsiPaaS

Properties

Name	Type	Description
type	string	The type of Input Field
id	string	The identifier for this Input Field
default_value	string	The default value for this Input Field if not otherwise specified
depends_on	array	A list of dependencies for this Input Field
description	string	The description of this Input Field
format	object	The format of this Input Field from one of options provided * `DATETIME` - DATETIME * `MULTILINE` - MULTILINE * `PASSWORD` - PASSWORD * `CODE` - CODE * `READONLY` - READONLY * `FILE` - FILE * `SELECT`
invalidates_input_fields	boolean	Whether this Input Field invalidates
is_required	boolean	Whether this Input Field is required
items	object	A freeform object of items for this Input Field
placeholder	string	The placeholder for this Input Field when shown
title	string	The title of this Input Field
value_type	object	The type of the value of this Input Field * `STRING` - STRING * `NUMBER` - NUMBER * `INTEGER` - INTEGER * `BOOLEAN` - BOOLEAN * `ARRAY` - ARRAY * `OBJECT` - OBJECT

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "InputField",
  "description": "Represents Input Field data as accepted by the API",
  "$id": "https://raw.githubusercontent.com/api-evangelist/zapier/refs/heads/main/json-schema/partner-api-input-field-schema.json",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "readOnly": true,
      "description": "The type of Input Field",
      "example": "standard"
    },
    "id": {
      "type": "string",
      "description": "The identifier for this Input Field",
      "example": "500123"
    },
    "default_value": {
      "type": "string",
      "description": "The default value for this Input Field if not otherwise specified",
      "example": "example-value"
    },
    "depends_on": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of dependencies for this Input Field",
      "example": [
        "example-value"
      ]
    },
    "description": {
      "type": "string",
      "description": "The description of this Input Field",
      "example": "Example description for this resource."
    },
    "format": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FormatEnum"
        }
      ],
      "description": "The format of this Input Field from one of options provided\n\n* `DATETIME` - DATETIME\n* `MULTILINE` - MULTILINE\n* `PASSWORD` - PASSWORD\n* `CODE` - CODE\n* `READONLY` - READONLY\n* `FILE` - FILE\n* `SELECT` - SELECT",
      "example": "example-value"
    },
    "invalidates_input_fields": {
      "type": "boolean",
      "description": "Whether this Input Field invalidates",
      "example": true
    },
    "is_required": {
      "type": "boolean",
      "description": "Whether this Input Field is required",
      "example": true
    },
    "items": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "A freeform object of items for this Input Field",
      "example": {}
    },
    "placeholder": {
      "type": "string",
      "description": "The placeholder for this Input Field when shown",
      "example": "example-value"
    },
    "title": {
      "type": "string",
      "description": "The title of this Input Field",
      "example": "Example Name"
    },
    "value_type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ValueTypeEnum"
        }
      ],
      "description": "The type of the *value* of this Input Field\n\n* `STRING` - STRING\n* `NUMBER` - NUMBER\n* `INTEGER` - INTEGER\n* `BOOLEAN` - BOOLEAN\n* `ARRAY` - ARRAY\n* `OBJECT` - OBJECT",
      "example": "standard"
    }
  },
  "required": [
    "default_value",
    "depends_on",
    "description",
    "format",
    "id",
    "invalidates_input_fields",
    "is_required",
    "items",
    "placeholder",
    "title",
    "type",
    "value_type"
  ]
}