Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. FormFieldSet
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

filescom.FormFieldSet

filescom logo
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
Schema (JSON)
jschady/pulumi-filescom

    A Form Field Set is a custom form to be used for bundle and inbox registrations.

    Each Form Field Set contains one or more Form Fields. A form and all of its form fields are submitted in a single create request. The order of form fields in the array is the order they will be displayed.

    Once created, a form field set can then be associated with one or more bundle(s) and/or inbox(s). Once associated, you will be required to submit well-formatted form-data when creating a bundle-registration or inbox registration.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as filescom from "pulumi-filescom";

const exampleFormFieldSet = new filescom.FormFieldSet("example_form_field_set", {
    userId: 1,
    title: "Sample Form Title",
    workspaceId: 1,
    skipEmail: false,
    skipName: false,
    skipCompany: false,
    formFields: [{
        label: "Sample Label",
        required: true,
        helpText: "Help Text",
        fieldType: "text",
        optionsForSelect: [
            "red",
            "green",
            "blue",
        ],
        defaultOption: "red",
        formFieldSetId: 1,
    }],
});

    import pulumi
import pulumi_filescom as filescom

example_form_field_set = filescom.FormFieldSet("example_form_field_set",
    user_id=1,
    title="Sample Form Title",
    workspace_id=1,
    skip_email=False,
    skip_name=False,
    skip_company=False,
    form_fields=[{
        "label": "Sample Label",
        "required": True,
        "helpText": "Help Text",
        "fieldType": "text",
        "optionsForSelect": [
            "red",
            "green",
            "blue",
        ],
        "defaultOption": "red",
        "formFieldSetId": 1,
    }])

    package main

import (
	"github.com/jschady/pulumi-filescom/sdk/go/filescom"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := filescom.NewFormFieldSet(ctx, "example_form_field_set", &filescom.FormFieldSetArgs{
			UserId:      pulumi.Int(1),
			Title:       pulumi.String("Sample Form Title"),
			WorkspaceId: pulumi.Int(1),
			SkipEmail:   pulumi.Bool(false),
			SkipName:    pulumi.Bool(false),
			SkipCompany: pulumi.Bool(false),
			FormFields: pulumi.Any{
				map[string]interface{}{
					"label":     "Sample Label",
					"required":  true,
					"helpText":  "Help Text",
					"fieldType": "text",
					"optionsForSelect": []string{
						"red",
						"green",
						"blue",
					},
					"defaultOption":  "red",
					"formFieldSetId": 1,
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Filescom = Jschady.Filescom;

return await Deployment.RunAsync(() => 
{
    var exampleFormFieldSet = new Filescom.FormFieldSet("example_form_field_set", new()
    {
        UserId = 1,
        Title = "Sample Form Title",
        WorkspaceId = 1,
        SkipEmail = false,
        SkipName = false,
        SkipCompany = false,
        FormFields = new[]
        {
            
            {
                { "label", "Sample Label" },
                { "required", true },
                { "helpText", "Help Text" },
                { "fieldType", "text" },
                { "optionsForSelect", new[]
                {
                    "red",
                    "green",
                    "blue",
                } },
                { "defaultOption", "red" },
                { "formFieldSetId", 1 },
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.filescom.FormFieldSet;
import com.pulumi.filescom.FormFieldSetArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var exampleFormFieldSet = new FormFieldSet("exampleFormFieldSet", FormFieldSetArgs.builder()
            .userId(1)
            .title("Sample Form Title")
            .workspaceId(1)
            .skipEmail(false)
            .skipName(false)
            .skipCompany(false)
            .formFields(Map.ofEntries(
                Map.entry("label", "Sample Label"),
                Map.entry("required", true),
                Map.entry("helpText", "Help Text"),
                Map.entry("fieldType", "text"),
                Map.entry("optionsForSelect", Arrays.asList(                
                    "red",
                    "green",
                    "blue")),
                Map.entry("defaultOption", "red"),
                Map.entry("formFieldSetId", 1)
            ))
            .build());

    }
}

    resources:
  exampleFormFieldSet:
    type: filescom:FormFieldSet
    name: example_form_field_set
    properties:
      userId: 1
      title: Sample Form Title
      workspaceId: 1
      skipEmail: false
      skipName: false
      skipCompany: false
      formFields:
        - label: Sample Label
          required: true
          helpText: Help Text
          fieldType: text
          optionsForSelect:
            - red
            - green
            - blue
          defaultOption: red
          formFieldSetId: 1

    pulumi {
  required_providers {
    filescom = {
      source = "pulumi/filescom"
    }
  }
}

resource "filescom_formfieldset" "example_form_field_set" {
  user_id      = 1
  title        = "Sample Form Title"
  workspace_id = 1
  skip_email   = false
  skip_name    = false
  skip_company = false
  form_fields = [{
    "label"            = "Sample Label"
    "required"         = true
    "helpText"         = "Help Text"
    "fieldType"        = "text"
    "optionsForSelect" = ["red", "green", "blue"]
    "defaultOption"    = "red"
    "formFieldSetId"   = 1
  }]
}

    Create FormFieldSet Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new FormFieldSet(name: string, args?: FormFieldSetArgs, opts?: CustomResourceOptions);
    @overload
def FormFieldSet(resource_name: str,
                 args: Optional[FormFieldSetArgs] = None,
                 opts: Optional[ResourceOptions] = None)

@overload
def FormFieldSet(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 form_fields: Optional[Any] = None,
                 skip_company: Optional[bool] = None,
                 skip_email: Optional[bool] = None,
                 skip_name: Optional[bool] = None,
                 title: Optional[str] = None,
                 user_id: Optional[int] = None,
                 workspace_id: Optional[int] = None)
    func NewFormFieldSet(ctx *Context, name string, args *FormFieldSetArgs, opts ...ResourceOption) (*FormFieldSet, error)
    public FormFieldSet(string name, FormFieldSetArgs? args = null, CustomResourceOptions? opts = null)
    public FormFieldSet(String name, FormFieldSetArgs args)
public FormFieldSet(String name, FormFieldSetArgs args, CustomResourceOptions options)

    type: filescom:FormFieldSet
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "filescom_form_field_set" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args FormFieldSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args FormFieldSetArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args FormFieldSetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FormFieldSetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FormFieldSetArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var formFieldSetResource = new Filescom.FormFieldSet("formFieldSetResource", new()
{
    FormFields = "any",
    SkipCompany = false,
    SkipEmail = false,
    SkipName = false,
    Title = "string",
    UserId = 0,
    WorkspaceId = 0,
});

    example, err := filescom.NewFormFieldSet(ctx, "formFieldSetResource", &filescom.FormFieldSetArgs{
	FormFields:  pulumi.Any("any"),
	SkipCompany: pulumi.Bool(false),
	SkipEmail:   pulumi.Bool(false),
	SkipName:    pulumi.Bool(false),
	Title:       pulumi.String("string"),
	UserId:      pulumi.Int(0),
	WorkspaceId: pulumi.Int(0),
})

    resource "filescom_form_field_set" "formFieldSetResource" {
  lifecycle {
    create_before_destroy = true
  }
  form_fields  = "any"
  skip_company = false
  skip_email   = false
  skip_name    = false
  title        = "string"
  user_id      = 0
  workspace_id = 0
}

    var formFieldSetResource = new FormFieldSet("formFieldSetResource", FormFieldSetArgs.builder()
    .formFields("any")
    .skipCompany(false)
    .skipEmail(false)
    .skipName(false)
    .title("string")
    .userId(0)
    .workspaceId(0)
    .build());

    form_field_set_resource = filescom.FormFieldSet("formFieldSetResource",
    form_fields="any",
    skip_company=False,
    skip_email=False,
    skip_name=False,
    title="string",
    user_id=0,
    workspace_id=0)

    const formFieldSetResource = new filescom.FormFieldSet("formFieldSetResource", {
    formFields: "any",
    skipCompany: false,
    skipEmail: false,
    skipName: false,
    title: "string",
    userId: 0,
    workspaceId: 0,
});

    type: filescom:FormFieldSet
properties:
    formFields: any
    skipCompany: false
    skipEmail: false
    skipName: false
    title: string
    userId: 0
    workspaceId: 0

    FormFieldSet Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The FormFieldSet resource accepts the following input properties:

    FormFields object
    Associated form fields
    SkipCompany bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
    SkipEmail bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
    SkipName bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
    Title string
    Title to be displayed
    UserId int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    WorkspaceId int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Workspace ID
    FormFields interface{}
    Associated form fields
    SkipCompany bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
    SkipEmail bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
    SkipName bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
    Title string
    Title to be displayed
    UserId int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    WorkspaceId int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Workspace ID
    form_fields any
    Associated form fields
    skip_company bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
    skip_email bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
    skip_name bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
    title string
    Title to be displayed
    user_id number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    workspace_id number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Workspace ID
    formFields Object
    Associated form fields
    skipCompany Boolean
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
    skipEmail Boolean
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
    skipName Boolean
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
    title String
    Title to be displayed
    userId Integer
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    workspaceId Integer
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Workspace ID
    formFields any
    Associated form fields
    skipCompany boolean
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
    skipEmail boolean
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
    skipName boolean
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
    title string
    Title to be displayed
    userId number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    workspaceId number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Workspace ID
    form_fields Any
    Associated form fields
    skip_company bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
    skip_email bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
    skip_name bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
    title str
    Title to be displayed
    user_id int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    workspace_id int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Workspace ID
    formFields Any
    Associated form fields
    skipCompany Boolean
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
    skipEmail Boolean
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
    skipName Boolean
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
    title String
    Title to be displayed
    userId Number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    workspaceId Number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Workspace ID

    Outputs

    All input properties are implicitly available as output properties. Additionally, the FormFieldSet resource produces the following output properties:

    FormLayouts List<int>
    Layout of the form
    Id string
    The provider-assigned unique ID for this managed resource.
    InUse bool
    Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration
    FormLayouts []int
    Layout of the form
    Id string
    The provider-assigned unique ID for this managed resource.
    InUse bool
    Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration
    form_layouts list(number)
    Layout of the form
    id string
    The provider-assigned unique ID for this managed resource.
    in_use bool
    Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration
    formLayouts List<Integer>
    Layout of the form
    id String
    The provider-assigned unique ID for this managed resource.
    inUse Boolean
    Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration
    formLayouts number[]
    Layout of the form
    id string
    The provider-assigned unique ID for this managed resource.
    inUse boolean
    Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration
    form_layouts Sequence[int]
    Layout of the form
    id str
    The provider-assigned unique ID for this managed resource.
    in_use bool
    Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration
    formLayouts List<Number>
    Layout of the form
    id String
    The provider-assigned unique ID for this managed resource.
    inUse Boolean
    Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration

    Look up Existing FormFieldSet Resource

    Get an existing FormFieldSet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: FormFieldSetState, opts?: CustomResourceOptions): FormFieldSet
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        form_fields: Optional[Any] = None,
        form_layouts: Optional[Sequence[int]] = None,
        in_use: Optional[bool] = None,
        skip_company: Optional[bool] = None,
        skip_email: Optional[bool] = None,
        skip_name: Optional[bool] = None,
        title: Optional[str] = None,
        user_id: Optional[int] = None,
        workspace_id: Optional[int] = None) -> FormFieldSet
    func GetFormFieldSet(ctx *Context, name string, id IDInput, state *FormFieldSetState, opts ...ResourceOption) (*FormFieldSet, error)
    public static FormFieldSet Get(string name, Input<string> id, FormFieldSetState? state, CustomResourceOptions? opts = null)
    public static FormFieldSet get(String name, Output<String> id, FormFieldSetState state, CustomResourceOptions options)
    resources:  _:    type: filescom:FormFieldSet    get:      id: ${id}
    import {
  to = filescom_form_field_set.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    FormFields object
    Associated form fields
    FormLayouts List<int>
    Layout of the form
    InUse bool
    Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration
    SkipCompany bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
    SkipEmail bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
    SkipName bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
    Title string
    Title to be displayed
    UserId int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    WorkspaceId int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Workspace ID
    FormFields interface{}
    Associated form fields
    FormLayouts []int
    Layout of the form
    InUse bool
    Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration
    SkipCompany bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
    SkipEmail bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
    SkipName bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
    Title string
    Title to be displayed
    UserId int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    WorkspaceId int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Workspace ID
    form_fields any
    Associated form fields
    form_layouts list(number)
    Layout of the form
    in_use bool
    Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration
    skip_company bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
    skip_email bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
    skip_name bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
    title string
    Title to be displayed
    user_id number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    workspace_id number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Workspace ID
    formFields Object
    Associated form fields
    formLayouts List<Integer>
    Layout of the form
    inUse Boolean
    Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration
    skipCompany Boolean
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
    skipEmail Boolean
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
    skipName Boolean
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
    title String
    Title to be displayed
    userId Integer
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    workspaceId Integer
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Workspace ID
    formFields any
    Associated form fields
    formLayouts number[]
    Layout of the form
    inUse boolean
    Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration
    skipCompany boolean
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
    skipEmail boolean
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
    skipName boolean
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
    title string
    Title to be displayed
    userId number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    workspaceId number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Workspace ID
    form_fields Any
    Associated form fields
    form_layouts Sequence[int]
    Layout of the form
    in_use bool
    Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration
    skip_company bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
    skip_email bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
    skip_name bool
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
    title str
    Title to be displayed
    user_id int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    workspace_id int
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Workspace ID
    formFields Any
    Associated form fields
    formLayouts List<Number>
    Layout of the form
    inUse Boolean
    Form Field Set is in use by an active Inbox / Bundle / Inbox Registration / Bundle Registration
    skipCompany Boolean
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing company
    skipEmail Boolean
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing email
    skipName Boolean
    Any associated InboxRegistrations or BundleRegistrations can be saved without providing name
    title String
    Title to be displayed
    userId Number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. User ID. Provide a value of 0 to operate the current session's user.
    workspaceId Number
    NOTE: This field is write-only and its value will not be updated in state as part of read operations. Workspace ID

    Import

    The pulumi import command can be used, for example:

    Form Field Sets can be imported by specifying the id.

    $ pulumi import filescom:index/formFieldSet:FormFieldSet example_form_field_set 1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    filescom jschady/pulumi-filescom
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the filescom Terraform Provider.
    filescom logo
    Viewing docs for Files.com v0.1.1
    published on Thursday, Aug 20, 2026 by jschady
    Schema (JSON)
    jschady/pulumi-filescom

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial