Skip to content
campaiDeveloper
campai.com

API reference · Schemas

FormDataValue

One answer of a form, of the kind its field gives.

Structure

One of these kinds:

  • string · date-time

    A date and time, as an ISO 8601 string.

    "2026-10-22T12:00:00Z"
  • string

    Text: the answer of a text field, the chosen option of a select field, or a date or time field as text.

    "string"
  • number

    The answer of a number or rating field.

    1
  • boolean

    The answer of a yes/no field, or whether terms and privacy were accepted.

    true
  • object

    The answer of a payment method field.

    3 properties
    • typestring
      sepaCreditTransfer sepaDirectDebit cash online
    • sepaDirectDebitobject
      2 properties
      • ibanstring · iban
      • bicstringnullable
    • onlineobject
      2 properties
      • paymentIntentidnullable
      • providerstringnullable
        stripe paypal
    {
      "type": "sepaCreditTransfer"
    }
  • object

    A stored file, such as a signature.

    4 properties
    • resourcestring

      at least 1 characters

    • fileNamestring

      at most 128 characters

    • contentTypestring

      at most 75 characters

    • fileSizeBytesinteger

      at least 0

    {
      "resource": "string"
    }
  • object

    A file to store, by the resource of its upload.

    2 properties
    • fileNamestring

      at most 128 characters

    • resourcestring
    {
      "resource": "string"
    }
  • object

    The answer of an address field.

    7 properties
    • countrystring
    • statestring
    • zipstring
    • citystring
    • addressLinestring
    • details1string
    • details2string
    {
      "country": "string",
      "state": "string",
      "zip": "string"
    }
  • object of number | number[]

    The answer of a matrix field: the chosen column, or columns, by row.

    {
      "key": 1
    }
  • string[]

    The chosen options of a multiple select field.

    [
      "string"
    ]

Used by

51 endpoints take or return FormDataValue.