Marketo Form Fields API

openapi: 3.2.0
info:
  description: Marketo Engage Rest API
  version: '1.0'
  title: Marketo Engage Rest Form Fields API
  termsOfService: https://www.adobe.com/legal.html
  contact:
    name: Adobe Developer Relations
    url: https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/home
    email: ''
  license:
    name: API License Agreement
    url: https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/api-license
servers:
- url: https://localhost:8080/
tags:
- name: Form Fields
  description: Form Field Controller
paths:
  /rest/asset/v1/form/fields.json:
    get:
      tags:
      - Form Fields
      summary: Get Available Form Fields
      description: 'Retrieves a list of all valid fields for use in forms. Required Permissions: Read-Only Assets, Read-Write Assets'
      operationId: getAllFieldsUsingGET
      parameters:
      - name: maxReturn
        in: query
        description: Maximum number of fields to return. Max 200, default 20
        required: false
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        description: Integer offset for paging
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOfFieldsMetaDataResponse'
  /rest/asset/v1/form/programMemberFields.json:
    get:
      tags:
      - Form Fields
      summary: Get Available Form Program Member Fields
      description: 'Retrieves a list of all valid Program Member fields for use in forms. Required Permissions: Read-Only Assets, Read-Write Assets'
      operationId: getAllProgramMemberFieldsUsingGET
      parameters:
      - name: maxReturn
        in: query
        description: Maximum number of fields to return. Max 200, default 20
        required: false
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        description: Integer offset for paging
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOfFieldsMetaDataResponse'
  /rest/asset/v1/form/{formId}/field/{fieldId}/visibility.json:
    post:
      tags:
      - Form Fields
      summary: Add Form Field Visibility Rules
      description: 'Adds a visibility rule to the target form field. Required Permissions: Read-Write Assets'
      operationId: addFormFieldVisibilityRuleUsingPOST
      parameters:
      - name: formId
        in: path
        description: formId
        required: true
        schema:
          type: integer
          format: int32
      - name: fieldId
        in: path
        description: fieldId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOfFormVisibilityRuleResponse'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AddFormFieldVisibilityRequest'
        description: addFormFieldVisibilityRequest
        required: true
  /rest/asset/v1/form/{id}/field/{fieldId}.json:
    post:
      tags:
      - Form Fields
      summary: Update Form Field
      description: 'Updates the configuration for that target field. Required Permissions: Read-Write Assets'
      operationId: updateFormFieldUsingPOST
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: fieldId
        in: path
        description: fieldId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOfLpFormFieldResponse'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateFormFieldRequest'
        description: updateFormFieldRequest
        required: true
  /rest/asset/v1/form/{id}/field/{fieldId}/delete.json:
    post:
      tags:
      - Form Fields
      summary: Delete Form Field
      description: 'Deletes a field from a form. Required Permissions: Read-Write Assets'
      operationId: deleteFormFieldUsingPOST
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: fieldId
        in: path
        description: fieldId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOfIdResponse'
  /rest/asset/v1/form/{id}/fieldSet.json:
    post:
      tags:
      - Form Fields
      summary: Add Fieldset to Form
      description: 'Adds a field set to the target form. Required Permissions: Read-Write Assets'
      operationId: addFieldSetUsingPOST
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOfLpFormFieldResponse'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AddFormFieldSetRequest'
        description: addFormFieldSetRequest
        required: true
  /rest/asset/v1/form/{id}/fieldSet/{fieldSetId}/field/{fieldId}/delete.json:
    post:
      tags:
      - Form Fields
      summary: Delete Field from Fieldset
      description: 'Removes the target field from the fieldset. Required Permissions: Read-Write Assets'
      operationId: deleteFormFieldFromFieldSetUsingPOST
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: fieldSetId
        in: path
        description: fieldSetId
        required: true
        schema:
          type: string
      - name: fieldId
        in: path
        description: fieldId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOfIdResponse'
  /rest/asset/v1/form/{id}/fields.json:
    get:
      tags:
      - Form Fields
      summary: Get Fields for Form
      description: 'Retrieves the list of fields in the target form. Required Permissions: Read-Only Assets, Read-Write Assets'
      operationId: getFormFieldByFormVidUsingGET
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: status
        in: query
        description: Status filter for draft or approved versions
        required: false
        schema:
          type: string
          enum:
          - approved
          - draft
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOfLpFormFieldResponse'
    post:
      tags:
      - Form Fields
      summary: Add Field to Form
      description: 'Adds a field to a form. Required Permissions: Read-Write Assets'
      operationId: addFieldToAFormUsingPOST
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOfLpFormFieldResponse'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AddFormFieldRequest'
        description: addFormFieldSetRequest
        required: true
  /rest/asset/v1/form/{id}/reArrange.json:
    post:
      tags:
      - Form Fields
      summary: Update Field Positions
      description: 'Reorders the list of fields in a form. Required Permissions: Read-Write Assets'
      operationId: updateFieldPositionsUsingPOST
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOfIdResponse'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ReArrangeRequest'
        description: reArrangeRequest
  /rest/asset/v1/form/{id}/richText.json:
    post:
      tags:
      - Form Fields
      summary: Add Rich Text Field
      description: 'Adds a rich-text type field to the form. Required Permissions: Read-Write Assets'
      operationId: addRichTextFieldUsingPOST
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOfLpFormFieldResponse'
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AddRichTextRequest'
        description: addRichTextRequest
        required: true
components:
  schemas:
    FormFieldVisibilityRequest:
      type: object
      required:
      - ruleType
      - rules
      properties:
        ruleType:
          type: string
          description: Type of rule to apply
          enum:
          - show
          - alwaysShow
          - hide
        rules:
          type: array
          description: JSON Array of rules
          items:
            $ref: '#/components/schemas/VisibilityRuleRequest'
    VisibilityRuleRequest:
      type: object
      required:
      - operator
      - subjectField
      - values
      properties:
        altLabel:
          type: string
        operator:
          type: string
          description: Operation to apply to target field. Evaluated against the list of values when applicable.
          enum:
          - is
          - isNot
          - isEmpty
          - isNotEmpty
          - startsWith
          - notStartsWith
          - endsWith
          - notEndsWith
          - contains
          - notContains
          - greaterThan
          - lessThan
          - atLeast
          - atMost
          - between
          - notBetween
          - notInTimeFrame
          - inPast
          - notInPast
          - after
          - before
          - inTimeFrame
          - onOrAfter
          - onOrBefore
        pickListValues:
          type: array
          description: Alternative label to display when rules are applied.
          items:
            $ref: '#/components/schemas/PickListDTO'
        subjectField:
          type: string
          description: Target field id to apply the operation defined by operator to
        values:
          type: array
          description: Comma-separated list of values to match against. Valid for operators 'is', 'isNot', 'startsWith', 'notStartsWith', 'endsWith', 'notEndsWith', 'contains', and 'notContains'
          items:
            type: string
    Error:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: string
          description: Error code of the error. See full list of error codes <a href="https://developers.marketo.com/rest-api/error-codes/">here</a>
        message:
          type: string
          description: Message describing the cause of the error
    ReArrangeRequest:
      type: object
      properties:
        positions:
          type: array
          items:
            $ref: '#/components/schemas/UpdateFieldPosition'
    AddRichTextRequest:
      type: object
      required:
      - text
      properties:
        text:
          type: string
          description: Multipart file. HTML Content for the rich text field.
    FormVisibilityRuleDTO:
      type: object
      properties:
        altLabel:
          type: string
        operator:
          type: string
        picklistFilterValues:
          type: array
          items:
            $ref: '#/components/schemas/PickListDTO'
        subjectField:
          type: string
        values:
          type: array
          items:
            type: string
    FormVisibilityRuleResponse:
      type: object
      properties:
        formFieldId:
          type: string
        ruleType:
          type: string
        rules:
          type: array
          items:
            $ref: '#/components/schemas/FormVisibilityRuleDTO'
    UpdateFormFieldRequest:
      type: object
      properties:
        blankFields:
          type: integer
          format: int32
          description: Number of blank fields to show when progressive profiling is enabled
        defaultValue:
          type: string
          description: Optional default value for the field
        fieldType:
          type: string
          description: Type of field
        fieldWidth:
          type: integer
          format: int32
          description: Width of the input or select element
        formPrefill:
          type: boolean
          description: Whether the field should prefill. Default true
        isSensitive:
          type: boolean
          description: Whether the field is marked as sensitive. Default false
        hintText:
          type: string
          description: Hint text for the field
        initiallyChecked:
          type: boolean
          description: Whether the field should be checked upon loading. Default false
        instructions:
          type: string
          description: Instructions for the field
        label:
          type: string
          description: Label of the field
        labelToRight:
          type: boolean
          description: Whether the field label should be displayed to the right of the input/select element. Default false
        labelWidth:
          type: integer
          format: int32
          description: Width of the field label element
        maskInput:
          type: string
          description: Optional input mask for the field
        maxLength:
          type: integer
          format: int32
          description: Maximum length for text type fields
        maxValue:
          type: number
          format: float
          description: Maximum value accepted by the field
        minValue:
          type: number
          format: float
          description: Minimum value accepted by the field
        multiSelect:
          type: boolean
          description: Whether the field should allow multiple selections. Default false
        required:
          type: boolean
          description: Whether the field is required to submit the form. Default false
        validationMessage:
          type: string
          description: Validation message to display on failed validation
        values:
          type: string
          description: 'Array of JSON objects that contain field attributes. Only for select-field types. Example: values=[{''label'':''Select...'',''value'':'''',''isDefault'':true,''selected'':true}, {''label'':''MR'',''value'':''Mr''}, {''label'':''MS'',''value'':''Ms''}, {''label'':''MRS'',''value'':''Mrs''}, {''label'':''DR'',''value'':''Dr''}, {''label'':''PROF'',''value'':''Prof''}]'
        visibleLines:
          type: integer
          format: int32
          description: Number of lines to display for the field element
    AddFormFieldVisibilityRequest:
      type: object
      properties:
        visibilityRule:
          $ref: '#/components/schemas/FormFieldVisibilityRequest'
    ResponseOfLpFormFieldResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        requestId:
          type: string
        result:
          type: array
          items:
            $ref: '#/components/schemas/LpFormFieldResponse'
        success:
          type: boolean
        warnings:
          type: array
          items:
            type: string
    ResponseOfFormVisibilityRuleResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        requestId:
          type: string
        result:
          type: array
          items:
            $ref: '#/components/schemas/FormVisibilityRuleResponse'
        success:
          type: boolean
        warnings:
          type: array
          items:
            type: string
    IdResponse:
      type: object
      required:
      - id
      properties:
        id:
          type: integer
          format: int32
          description: Id of the asset
    ResponseOfIdResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        requestId:
          type: string
        result:
          type: array
          items:
            $ref: '#/components/schemas/IdResponse'
        success:
          type: boolean
        warnings:
          type: array
          items:
            type: string
    FieldsMetaDataResponse:
      type: object
      required:
      - id
      properties:
        dataType:
          type: string
          description: Type of field
        defaultValue:
          type: string
          description: Optional default value for the field
        description:
          type: string
          description: Description of the field
        fieldMaskValues:
          type: string
          description: Optional input mask for the field
        fieldWidth:
          type: integer
          format: int32
          description: Width of the input or select element
        id:
          type: string
          description: Id of the field
        initiallyChecked:
          type: boolean
          description: Whether the field should be checked upon loading. Default false
        isLabelToRight:
          type: boolean
          description: Whether the field label should be displayed to the right of the input/select element. Default false
        isMultiselect:
          type: boolean
          description: Whether the field should allow multiple selections. Default false
        isRequired:
          type: boolean
          description: Whether the field is required to submit the form. Default false
        isSensitive:
          type: boolean
          description: Whether the field is marked as sensitive. Default false
        labelWidth:
          type: integer
          format: int32
          description: Width of the field label element
        maxLength:
          type: integer
          format: int32
          description: Maximum length for text type fields
        maximumNumber:
          type: number
          format: float
          description: Maximum value accepted by the field
        minimumNumber:
          type: number
          format: float
          description: Minimum value accepted by the field
        picklistValues:
          type: string
          description: Comma-separated list of available picklist values for the field
        placeholderText:
          type: string
          description: Placeholder text for the field
        validationMessage:
          type: string
          description: Validation message to display on failed validation
        visibleRows:
          type: integer
          format: int32
          description: Number of rows visible for progressive profiling
    LpFormFieldResponse:
      type: object
      properties:
        blankFields:
          type: integer
          format: int32
        columnNumber:
          type: integer
          format: int32
        dataType:
          type: string
        defaultValue:
          type: string
        fieldMetaData:
          type: object
        fieldWidth:
          type: integer
          format: int32
        fields:
          type: array
          items:
            type: string
        formPrefill:
          type: boolean
        isSensitive:
          type: boolean
        hintText:
          type: string
        id:
          type: string
        instructions:
          type: string
        label:
          type: string
        labelWidth:
          type: integer
          format: int32
        maxLength:
          type: integer
          format: int32
        required:
          type: boolean
        rowNumber:
          type: integer
          format: int32
        text:
          type: string
        validationMessage:
          type: object
        visibilityRules:
          $ref: '#/components/schemas/FormFieldVisibilityRuleResponse'
    ResponseOfFieldsMetaDataResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        requestId:
          type: string
        result:
          type: array
          items:
            $ref: '#/components/schemas/FieldsMetaDataResponse'
        success:
          type: boolean
        warnings:
          type: array
          items:
            type: string
    AddFormFieldRequest:
      type: object
      required:
      - fieldId
      properties:
        blankFields:
          type: integer
          format: int32
          description: Number of blank fields to show when progressive profiling is enabled
        defaultValue:
          type: string
          description: Optional default value for the field
        fieldId:
          type: string
          description: Id of the field
        fieldType:
          type: string
          description: Specifies the field type.
        fieldWidth:
          type: integer
          format: int32
          description: Width of the input or select element
        formPrefill:
          type: boolean
          description: Whether the field should prefill. Default true
        isSensitive:
          type: boolean
          description: Whether the field is marked as sensitive. Default false
        hintText:
          type: string
          description: Hint text for the field
        initiallyChecked:
          type: boolean
          description: Whether the field should be checked upon loading. Default false
        instructions:
          type: string
          description: Instructions for the field
        label:
          type: string
          description: Label of the field
        labelToRight:
          type: boolean
          description: Whether the field label should be displayed to the right of the input/select element. Default false
        labelWidth:
          type: integer
          format: int32
          description: Width of the field label element
        maskInput:
          type: string
          description: Optional input mask for the field
        maxLength:
          type: integer
          format: int32
          description: Maximum length for text type fields
        maxValue:
          type: number
          format: float
          description: Maximum value accepted by the field
        minValue:
          type: number
          format: float
          description: Minimum value accepted by the field
        multiSelect:
          type: boolean
          description: Whether the field should allow multiple selections. Default false
        required:
          type: boolean
          description: Whether the field is required to submit the form. Default false
        validationMessage:
          type: string
          description: Validation message to display on failed validation
        values:
          type: string
          description: Comma-separated list of accepted values for the field. Only for select-field types
        visibleLines:
          type: integer
          format: int32
          description: Number of lines to display for the field element
    FormFieldVisibilityRuleResponse:
      type: object
      properties:
        ruleType:
          type: string
        rules:
          type: array
          items:
            $ref: '#/components/schemas/FormVisibilityRuleDTO'
    PickListDTO:
      type: object
      properties:
        isDefault:
          type: boolean
        label:
          type: string
        selected:
          type: boolean
        value:
          type: string
    AddFormFieldSetRequest:
      type: object
      required:
      - label
      properties:
        label:
          type: string
          description: Label of the fieldset
    UpdateFieldPosition:
      type: object
      required:
      - columnNumber
      - fieldName
      - rowNumber
      properties:
        columnNumber:
          type: integer
          format: int32
          description: Column number of the field
        fieldList:
          type: array
          description: List of positions inside the fields. Only valid if the target is a fieldset
          items:
            $ref: '#/components/schemas/UpdateFieldPosition'
        fieldName:
          type: string
          description: Id of the field
        rowNumber:
          type: integer
          format: int32
          description: Row number of the field