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

# Set All Form Field Restrictions

> Sets the list of form field restrictions.

Note: This list is the conclusion of what should exist in the table. Restrictions that already exists in the table are edited, new ones are added, and if they are not in this list, they will be deleted
NsApiSlow threshold: 5000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-MarketingAgent.json post /api/v1/Agents/Marketing/SetAllFormFieldRestrictions
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/SetAllFormFieldRestrictions:
    post:
      tags:
        - Marketing_Agent
      summary: Set All Form Field Restrictions
      description: "Sets the list of form field restrictions.\n\nNote: This list is the conclusion of what should exist in the table. Restrictions that already exists in the table are edited, new ones are added, and if they are not in this list, they will be deleted\r\nNsApiSlow threshold: 5000 ms."
      operationId: v1MarketingAgent_SetAllFormFieldRestrictions
      parameters:
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category". Default = show all fields.
          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
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.MarketingCarriers.SetAllFormFieldRestrictionsRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.MarketingCarriers.SetAllFormFieldRestrictionsRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.MarketingCarriers.SetAllFormFieldRestrictionsRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.MarketingCarriers.SetAllFormFieldRestrictionsRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.MarketingCarriers.SetAllFormFieldRestrictionsRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.MarketingCarriers.SetAllFormFieldRestrictionsRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.MarketingCarriers.SetAllFormFieldRestrictionsRequest
        description: FormFieldRestrictions
        required: true
      responses:
        '204':
          description: No Content
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.MarketingCarriers.SetAllFormFieldRestrictionsRequest:
      description: >-
        SetAllFormFieldRestrictions: Sets the list of form field restrictions.
        Note: This list is the conclusion of what should exist in the table.
        Restrictions that already exists in the table are edited, new ones are
        added, and if they are not in this list, they will be deleted
      type: object
      properties:
        FormFieldRestrictions:
          type: array
          items:
            $ref: '#/components/schemas/SuperOffice.CRM.Services.FormFieldRestriction'
    SuperOffice.CRM.Services.FormFieldRestriction:
      description: "Carrier for FormFieldRestriction\r\n<para />\r\nCarrier object for FormFieldRestriction.\r\nServices for the FormFieldRestriction Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IMarketingAgent\">Marketing Agent</see>."
      type: object
      properties:
        FormFieldRestrictionId:
          format: int32
          description: Primary key
          type: integer
        FieldIdentifier:
          description: the identifier for the field
          type: string
        FieldRestriction:
          description: The restriction set on the field
          enum:
            - NotSet
            - ReadOnly
            - DoNotShow
          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

- [SuperOffice.WebApi.Data.Marketing SetAllFormFieldRestrictionsRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Marketing_SetAllFormFieldRestrictionsRequest.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)
- [Form field restrictions](/en/marketing/forms/admin/form-field-restrictions.md)
- [form_field_restriction table](/en/database/tables/form-field-restriction.md)
- [Enum values for FormFieldRestrictionType](/en/database/tables/enums/formfieldrestrictiontype.md)
