> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SuperOffice.WebApi.Data.FormEntity

# <a id="SuperOffice_WebApi_Data_FormEntity" /> Class FormEntity

Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\
Assembly: SuperOffice.WebApi.dll

Carrier object for FormEntity.
Definition and configuration of a Form

```csharp theme={null}
public class FormEntity : Carrier
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[FormEntity](SuperOffice.WebApi.Data.FormEntity.md)

#### Inherited Members

[Carrier.TableRight](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_TableRight),
[Carrier.FieldProperties](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_FieldProperties),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Examples

Get FormEntity 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new MarketingAgent(configuration);
var formEntity = agent.GetFormEntity( 123 );</code></pre>

## Constructors

### <a id="SuperOffice_WebApi_Data_FormEntity__ctor" /> FormEntity()

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public FormEntity()
```

## Properties

### <a id="SuperOffice_WebApi_Data_FormEntity_Active" /> Active

Indicates if this form is active or not

```csharp theme={null}
public virtual bool Active { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_FormEntity_Config" /> Config

The JSON-formatted config of this form

```csharp theme={null}
public virtual string Config { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_FormEntity_Description" /> Description

Detailed description

```csharp theme={null}
public virtual string Description { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_FormEntity_EmailFlows" /> EmailFlows

EmailFlows this form is used in (read-only)

```csharp theme={null}
public virtual int[] EmailFlows { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)\[]

### <a id="SuperOffice_WebApi_Data_FormEntity_Expires" /> Expires

After this datetime, the form will become inactive

```csharp theme={null}
public virtual DateTime Expires { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

### <a id="SuperOffice_WebApi_Data_FormEntity_FolderId" /> FolderId

The folder which this form belongs to. -1 indicates that the shipment is on the root

```csharp theme={null}
public virtual int FolderId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_FormEntity_FolderName" /> FolderName

The name of the folder for this form

```csharp theme={null}
public virtual string FolderName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_FormEntity_FormId" /> FormId

Primary key

```csharp theme={null}
public virtual int FormId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_FormEntity_FormKey" /> FormKey

A short string used as unique id to access this form

```csharp theme={null}
public virtual string FormKey { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_FormEntity_GroupId" /> GroupId

The group which this form belongs to.

```csharp theme={null}
public virtual int GroupId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_FormEntity_MaxSubmits" /> MaxSubmits

After this number of submits, the form will become inactive

```csharp theme={null}
public virtual int MaxSubmits { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_FormEntity_Name" /> Name

The name of this form

```csharp theme={null}
public virtual string Name { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_FormEntity_NewTicket" /> NewTicket

Indicates if this form creates a ticket or not

```csharp theme={null}
public virtual bool NewTicket { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_FormEntity_RecaptchaMode" /> RecaptchaMode

What is the state of the recaptcha configuration? This is a read-only member
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public FormsRecaptchaMode? RecaptchaMode { get; set; }
```

#### Property Value

[FormsRecaptchaMode](SuperOffice.WebApi.Data.FormsRecaptchaMode.md)?

#### See Also

[FormEntity](SuperOffice.WebApi.Data.FormEntity.md).[RecaptchaMode\_String](SuperOffice.WebApi.Data.FormEntity.md#SuperOffice_WebApi_Data_FormEntity_RecaptchaMode_String)

### <a id="SuperOffice_WebApi_Data_FormEntity_RecaptchaMode_String" /> RecaptchaMode\_String

What is the state of the recaptcha configuration? This is a read-only member
Raw string enum value.

```csharp theme={null}
[JsonProperty("RecaptchaMode")]
public string RecaptchaMode_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[FormEntity](SuperOffice.WebApi.Data.FormEntity.md).[RecaptchaMode](SuperOffice.WebApi.Data.FormEntity.md#SuperOffice_WebApi_Data_FormEntity_RecaptchaMode)

### <a id="SuperOffice_WebApi_Data_FormEntity_Recipe" /> Recipe

The JSON-formatted recipe of this form

```csharp theme={null}
public virtual string Recipe { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_FormEntity_Registered" /> Registered

Registered when

```csharp theme={null}
public virtual DateTime Registered { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

### <a id="SuperOffice_WebApi_Data_FormEntity_RegisteredAssociateId" /> RegisteredAssociateId

Registered by whom

```csharp theme={null}
public virtual int RegisteredAssociateId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_FormEntity_ResponseShipmentId" /> ResponseShipmentId

The id of the s\_shipment that is used to send the response mails

```csharp theme={null}
public virtual int ResponseShipmentId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_FormEntity_ScriptId" /> ScriptId

The CRMScript Macro which will be run when the form is submitted.

```csharp theme={null}
public virtual int ScriptId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_FormEntity_Type" /> Type

What kind of form is this? Indicates if this is a normal form or a template
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public FormType? Type { get; set; }
```

#### Property Value

[FormType](SuperOffice.WebApi.Data.FormType.md)?

#### See Also

[FormEntity](SuperOffice.WebApi.Data.FormEntity.md).[Type\_String](SuperOffice.WebApi.Data.FormEntity.md#SuperOffice_WebApi_Data_FormEntity_Type_String)

### <a id="SuperOffice_WebApi_Data_FormEntity_Type_String" /> Type\_String

What kind of form is this? Indicates if this is a normal form or a template
Raw string enum value.

```csharp theme={null}
[JsonProperty("Type")]
public string Type_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[FormEntity](SuperOffice.WebApi.Data.FormEntity.md).[Type](SuperOffice.WebApi.Data.FormEntity.md#SuperOffice_WebApi_Data_FormEntity_Type)

### <a id="SuperOffice_WebApi_Data_FormEntity_Updated" /> Updated

Last updated when

```csharp theme={null}
public virtual DateTime Updated { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

### <a id="SuperOffice_WebApi_Data_FormEntity_UpdatedAssociateId" /> UpdatedAssociateId

Last updated by whom

```csharp theme={null}
public virtual int UpdatedAssociateId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_FormEntity_UpdatedCount" /> UpdatedCount

Number of updates made to this record

```csharp theme={null}
public virtual short UpdatedCount { get; set; }
```

#### Property Value

[short](https://learn.microsoft.com/dotnet/api/system.int16)

## See Also

[MarketingAgent](SuperOffice.WebApi.Agents.MarketingAgent.md)


## Related topics

- [SuperOffice.WebApi.Agents.IMarketingAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IMarketingAgent.md)
- [SuperOffice.WebApi.Agents.MarketingAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.MarketingAgent.md)
- [SuperOffice.WebApi.Data.FormSubmissionEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.FormSubmissionEntity.md)
- [SuperOffice.WebApi.Data.PersonEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.PersonEntity.md)
- [SuperOffice.WebApi.Data.TicketEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.TicketEntity.md)
- [SuperOffice.WebApi.Data.CultureDataFormatter](/en/api/reference/webapi/SuperOffice.WebApi.Data.CultureDataFormatter.md)