> ## 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.

# Create Default Form Entity

> Loading default values into a new FormEntity.

NsApiSlow threshold: 5000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-MarketingAgent.json post /api/v1/Agents/Marketing/CreateDefaultFormEntity
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - MarketingAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Agents/Marketing/CreateDefaultFormEntity:
    post:
      tags:
        - Marketing_Agent
      summary: Create Default Form Entity
      description: |-
        Loading default values into a new FormEntity.

        NsApiSlow threshold: 5000 ms.
      operationId: v1MarketingAgent_CreateDefaultFormEntity
      parameters:
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.FormEntity'
            text/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.FormEntity'
            application/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.FormEntity'
            text/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.FormEntity'
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.FormEntity'
            application/merge-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.FormEntity'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.CRM.Services.FormEntity:
      description: "Definition and configuration of a Form\r\n<para />\r\nCarrier object for FormEntity.\r\nServices for the FormEntity Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IMarketingAgent\">Marketing Agent</see>."
      type: object
      properties:
        FormId:
          format: int32
          description: Primary key
          type: integer
        FormKey:
          description: A short string used as unique id to access this form
          type: string
        Name:
          description: The name of this form
          type: string
        Description:
          description: Detailed description
          type: string
        Config:
          description: The JSON-formatted config of this form
          type: string
        FolderId:
          format: int32
          description: >-
            The folder which this form belongs to. -1 indicates that the
            shipment is on the root
          type: integer
        ScriptId:
          format: int32
          description: The CRMScript Macro which will be run when the form is submitted.
          type: integer
        ResponseShipmentId:
          format: int32
          description: The id of the s_shipment that is used to send the response mails
          type: integer
        Active:
          description: Indicates if this form is active or not
          type: boolean
        Expires:
          format: date-time
          description: After this datetime, the form will become inactive
          type: string
        MaxSubmits:
          format: int32
          description: After this number of submits, the form will become inactive
          type: integer
        Type:
          description: >-
            What kind of form is this? Indicates if this is a normal form or a
            template
          enum:
            - Normal
            - Template
          type: string
        Recipe:
          description: The JSON-formatted recipe of this form
          type: string
        GroupId:
          format: int32
          description: The group which this form belongs to.
          type: integer
        NewTicket:
          description: Indicates if this form creates a ticket or not
          type: boolean
        RecaptchaMode:
          description: >-
            What is the state of the recaptcha configuration? This is a
            read-only member
          enum:
            - NotAvailable
            - GlobalKeysExist
            - KeysNeeded
          type: string
        Registered:
          format: date-time
          description: Registered when  in UTC.
          type: string
        RegisteredAssociateId:
          format: int32
          description: Registered by whom
          type: integer
        Updated:
          format: date-time
          description: Last updated when  in UTC.
          type: string
        UpdatedAssociateId:
          format: int32
          description: Last updated by whom
          type: integer
        UpdatedCount:
          format: int32
          description: Number of updates made to this record
          type: integer
        EmailFlows:
          description: EmailFlows this form is used in (read-only)
          type: array
          items:
            format: int32
            type: integer
        FolderName:
          description: The name of the folder for this form
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Security.TableRight:
      description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string
    SuperOffice.CRM.Security.FieldProperty:
      description: >-
        Class holding properties like field length, field type about a field in
        the carrier.
      type: object
      properties:
        FieldRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
        FieldType:
          type: string
        FieldLength:
          format: int32
          description: ''
          type: integer
    SuperOffice.CRM.Security.FieldRight:
      description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string

````

## Related topics

- [NSMarketingAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSMarketingAgent.md)
- [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)
- [Create Default Form Submission Entity](/en/api/reference/restful/agent/marketing_agent/create-default-form-submission-entity.md)
- [Create Default Chat Topic Entity](/en/api/reference/restful/agent/chat_agent/create-default-chat-topic-entity.md)
- [Create Default Trigger Script Entity](/en/api/reference/restful/agent/crmscript_agent/create-default-trigger-script-entity.md)
