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

# Create a field link

> **Permissions:** [Build Access](https://help.logicgate.com/hc/en-us/articles/4402683190164-Control-Build-Access-for-Applications)

Add a field to a section, optionally propagating the change to sibling steps. Returns the created field link.



## OpenAPI

````yaml POST /api/v1/internal/form/fieldLinks
openapi: 3.1.0
info:
  title: Risk Cloud API
  description: >-
    The Risk Cloud API is a collection of RESTful API endpoints that empower you
    and your team to directly integrate, automate, and build with the Risk
    Cloud. Risk Cloud API endpoint payloads are JSON based, with some endpoints
    supporting exports in CSV and XSLX formats for flexible integration.


    This API documentation showcases our Risk Cloud API v1, containing a variety
    of endpoints with continued support for enabling integrations with the Risk
    Cloud.


    Visit the [LogicGate Risk Cloud Developer
    Portal](https://www.logicgate.com/developer/) to get started with building
    your custom integration with quick start guides, usage guides, release
    notes, and more. Or download the [v1 OpenAPI
    specification](/legacy-openapi.json).


    Explore our [Risk Cloud API v2](https://docs.logicgate.com/v2/index.html)
    endpoints and documentation as well. [Risk Cloud API
    v2](https://docs.logicgate.com/v2/index.html) is our collection of API-First
    endpoints that are tailor made for our developer users, offer concise and
    highly documented details, are supported by a [Postman
    collection](https://www.postman.com/logicgate-postman/workspace/logicgate-risk-cloud-api/collection/29257227-de8d264b-6eeb-4177-bea6-2da0a8cabffc)
    and [v2 OpenAPI specification](https://github.com/LogicGateTech/openapi),
    and contain our latest API endpoint releases.
  contact:
    name: developer-relations@logicgate.com
    email: developer-relations@logicgate.com
  version: v2026.11.0
servers:
  - url: https://{subdomain}.logicgate.com
    description: Your Risk Cloud environment.
    variables:
      subdomain:
        description: Your Risk Cloud environment's subdomain (e.g. `qa`).
        default: your-instance
security:
  - ApiToken: []
  - basic: []
tags:
  - name: Authentication
    description: >-
      Getting Started: How to create an [API Access
      Token](https://www.logicgate.com/developer/risk-cloud-api-authentication/)
      to begin integrating with the Risk Cloud API
  - name: Attachment
    description: Endpoints for uploading, downloading, and retrieving record attachments.
  - name: Field
    description: Endpoints for creating, updating, and querying fields.
  - name: Principal
    description: >-
      Endpoints for the authenticated principal to view and manage their own
      details.
  - name: Record Audit
    description: Endpoints for retrieving record audit history and productivity data.
  - name: Step
    description: Endpoints for retrieving steps and the steps a user can access.
  - name: Table Report
    description: Endpoints for retrieving and managing table reports.
  - name: User Group
    description: Endpoints for managing user groups and their membership.
externalDocs:
  description: Developer Portal
  url: https://www.logicgate.com/developer/
paths:
  /api/v1/internal/form/fieldLinks:
    post:
      tags:
        - Field Link
      summary: Create a field link
      description: >-
        **Permissions:** [Build
        Access](https://help.logicgate.com/hc/en-us/articles/4402683190164-Control-Build-Access-for-Applications)


        Add a field to a section, optionally propagating the change to sibling
        steps. Returns the created field link.
      operationId: create_9
      parameters:
        - name: update-siblings
          in: query
          description: >-
            When true, apply the same field link to sibling steps in the
            workflow. Defaults to false.
          required: false
          schema:
            type: boolean
            default: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FieldLink_ExtendedSectionSummary'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FieldLink_ExtendedSectionSummary'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppStatusResponse_ExtendedSectionSummary'
        '403':
          description: Forbidden
components:
  schemas:
    FieldLink_ExtendedSectionSummary:
      allOf:
        - $ref: '#/components/schemas/Section_ExtendedSectionSummary'
        - type: object
          properties:
            required:
              type: boolean
            enabled:
              type: boolean
            displayGuidance:
              type: boolean
            onReadOnlySubsection:
              type: boolean
            column:
              type: integer
              format: int32
            labelDisplayType:
              type: string
              enum:
                - VALUE
                - LABEL
                - ALL
            field:
              $ref: '#/components/schemas/Field_ExtendedSectionSummary'
            fieldId:
              type: string
      description: The field link values to update.
      required:
        - active
        - collapsed
        - color
        - colspan
        - column
        - conditionsEnabled
        - conditionsUseAndOperator
        - created
        - defaultState
        - displayGuidance
        - enabled
        - field
        - fieldId
        - guidance
        - icon
        - id
        - labelDisplayType
        - name
        - onReadOnlySubsection
        - parentId
        - priority
        - required
        - step
        - stepId
        - updated
    AppStatusResponse_ExtendedSectionSummary:
      type: object
      properties:
        type:
          type: string
          format: uri
        title:
          type: string
        status:
          type: integer
          format: int32
        detail:
          type: string
        instance:
          type: string
          format: uri
        properties:
          type: object
          additionalProperties: {}
    Section_ExtendedSectionSummary:
      type: object
      discriminator:
        propertyName: sectionType
      oneOf:
        - $ref: '#/components/schemas/FormSection_ExtendedSectionSummary'
        - description: >-
            And other types: Dashboard_ExtendedSectionSummary,
            DashboardSection_ExtendedSectionSummary,
            FieldLink_ExtendedSectionSummary,
            FormSection_ExtendedSectionSummary,
            FormSection_ExtendedSectionSummary,
            FormSection_ExtendedSectionSummary,
            GraphReport_ExtendedSectionSummary,
            HtmlSection_ExtendedSectionSummary, VisualReport,
            WorkflowLink_ExtendedSectionSummary,
            AnalysisReport_ExtendedSectionSummary,
            EmbeddedReport_ExtendedSectionSummary,
            EvidenceSection_ExtendedSectionSummary,
            DataWarehouseLink_ExtendedSectionSummary,
            ScopingSection_ExtendedSectionSummary
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        name:
          type: string
        color:
          type: string
        icon:
          type: string
        guidance:
          type: string
        priority:
          type: integer
          format: int32
        colspan:
          type: integer
          format: int32
        collapsed:
          type: boolean
        defaultState:
          type: string
          enum:
            - HIDDEN
            - INACTIVE
        conditionsEnabled:
          type: boolean
        conditionsUseAndOperator:
          type: boolean
        step:
          $ref: '#/components/schemas/Step_ExtendedSectionSummary'
        stepId:
          type: string
        parentId:
          type: string
        sectionType:
          type: string
          enum:
            - CONTENT_SECTION
            - DASHBOARD
            - DASHBOARD_SECTION
            - FIELD_LINK
            - FORM_SECTION
            - GRAPH_REPORT
            - HTML_SECTION
            - STEP_PAGE
            - SUB_SECTION
            - VISUAL_REPORT
            - WORKFLOW_LINK
            - JIRA_WORKFLOW_LINK
            - ANALYSIS_REPORT
            - EMBEDDED_REPORT
            - EVIDENCE_SECTION
            - DATA_WAREHOUSE_LINK
            - SCOPING_SECTION
      required:
        - active
        - collapsed
        - color
        - colspan
        - conditionsEnabled
        - conditionsUseAndOperator
        - created
        - defaultState
        - guidance
        - icon
        - id
        - name
        - parentId
        - priority
        - step
        - stepId
        - updated
    Field_ExtendedSectionSummary:
      type: object
      description: >-
        An entity used to manage input fields used to capture record data for
        different workflows.
      discriminator:
        propertyName: fieldType
      oneOf:
        - $ref: '#/components/schemas/Text_ExtendedSectionSummary'
        - description: >-
            And other types: ExternalUser_ExtendedSectionSummary,
            ExternalId_ExtendedSectionSummary, TextArea_ExtendedSectionSummary,
            DatePicker_ExtendedSectionSummary, Number_ExtendedSectionSummary,
            ESignature_ExtendedSectionSummary, Checkbox_ExtendedSectionSummary,
            MultiSelect_ExtendedSectionSummary, Radio_ExtendedSectionSummary,
            Select_ExtendedSectionSummary, Attachment_ExtendedSectionSummary,
            User_ExtendedSectionSummary, Evidence_ExtendedSectionSummary,
            Calculation_ExtendedSectionSummary,
            FixedDateCalculation_ExtendedSectionSummary,
            LinkedRecordsCount_ExtendedSectionSummary,
            DueDate_ExtendedSectionSummary,
            TransientFieldDaysUntilDue_ExtendedSectionSummary,
            AnnualLossExposure_ExtendedSectionSummary,
            AecInfo_ExtendedSectionSummary, Text_ExtendedSectionSummary,
            ExternalUser_ExtendedSectionSummary,
            ExternalId_ExtendedSectionSummary, TextArea_ExtendedSectionSummary,
            DatePicker_ExtendedSectionSummary, Number_ExtendedSectionSummary,
            ESignature_ExtendedSectionSummary, Checkbox_ExtendedSectionSummary,
            MultiSelect_ExtendedSectionSummary, Radio_ExtendedSectionSummary,
            Select_ExtendedSectionSummary, Attachment_ExtendedSectionSummary,
            User_ExtendedSectionSummary, Evidence_ExtendedSectionSummary,
            Calculation_ExtendedSectionSummary,
            TextConcatenation_ExtendedSectionSummary,
            FixedDateCalculation_ExtendedSectionSummary,
            LinkedRecordsCount_ExtendedSectionSummary,
            DueDate_ExtendedSectionSummary,
            TransientFieldDaysUntilDue_ExtendedSectionSummary,
            AnnualLossExposure_ExtendedSectionSummary,
            AecInfo_ExtendedSectionSummary
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        fieldType:
          type: string
          enum:
            - TEXT
            - EXTERNAL_USER
            - EXTERNAL_ID
            - TEXT_AREA
            - DATE_PICKER
            - NUMBER
            - E_SIGNATURE
            - CHECKBOX
            - MULTI_SELECT
            - RADIO
            - SELECT
            - USER
            - ATTACHMENT
            - CALCULATION
            - TEXT_CONCATENATION
            - FIXED_DATE_CALCULATION
            - LINKED_RECORDS_COUNT
            - DUE_DATE
            - DAYS_UNTIL_DUE
            - EVIDENCE
            - AEC_INFO
            - ANNUAL_LOSS_EXPOSURE
        name:
          type: string
          description: The name of the field.
        labels:
          type: array
          items:
            type: string
          uniqueItems: true
        label:
          type: string
          description: >-
            The label will appear as the label for the field when it appears on
            forms for user's to complete.
        tooltip:
          type: string
          description: A text value that will populate any tooltip information.
        helpText:
          type: string
          description: >-
            A text value that supplies necessary context for a person to fill
            out an input field.
        format:
          type: string
          enum:
            - CURRENCY
            - DECIMAL
        currency:
          type: string
          enum:
            - EUR
            - GBP
            - USD
        enabledForRecordAccess:
          type: boolean
        currentValues:
          type: array
          description: >-
            Relationship to current values that are associated to the field. A
            field maybe have multiple current values associated to it.
          items:
            $ref: '#/components/schemas/CurrentValue_ExtendedSectionSummary'
        defaultValues:
          type: array
          description: >-
            Relationship to current values that are defaulted to the field. A
            field maybe have multiple default current values associated to it.
          items:
            $ref: '#/components/schemas/CurrentValue_ExtendedSectionSummary'
        analysisEstimate:
          type: string
          enum:
            - CONFIDENCE
            - MAXIMUM
            - MINIMUM
            - MOST_LIKELY
        analysisType:
          type: string
          enum:
            - CONTACT_FREQUENCY
            - LOSS_EVENT_FREQUENCY
            - LOSS_MAGNITUDE
            - PRIMARY_PRODUCTIVITY_LOSS
            - PRIMARY_RESPONSE_LOSS
            - PRIMARY_REPLACEMENT_LOSS
            - PRIMARY_COMPETITIVE_ADVANTAGE_LOSS
            - PRIMARY_FINES_OR_JUDGEMENTS_LOSS
            - PRIMARY_REPUTATION_DAMAGE_LOSS
            - PROBABILITY_OF_ACTION
            - RESISTANCE_STRENGTH
            - SECONDARY_PRODUCTIVITY_LOSS
            - SECONDARY_RESPONSE_LOSS
            - SECONDARY_REPLACEMENT_LOSS
            - SECONDARY_COMPETITIVE_ADVANTAGE_LOSS
            - SECONDARY_FINES_OR_JUDGEMENTS_LOSS
            - SECONDARY_REPUTATION_DAMAGE_LOSS
            - SECONDARY_LOSS_EVENT_FREQUENCY
            - SECONDARY_LOSS_MAGNITUDE
            - THREAT_CAPABILITY
            - THREAT_EVENT_FREQUENCY
            - VULNERABILITY
        operators:
          type: array
          items:
            type: string
            enum:
              - EQUALS
              - NOT_EQUALS
              - IS
              - IS_NOT
              - GREATER_THAN
              - GREATER_THAN_EQUALS
              - LESS_THAN
              - LESS_THAN_EQUALS
              - CONTAINS
              - DOES_NOT_CONTAIN
              - 'NULL'
              - NOT_NULL
              - DATE_RANGE
              - NUMERIC_RANGE
        convertibleTo:
          type: array
          items:
            type: string
        copyRecordAccessField:
          type: boolean
        currencyForNumberDisplayingFields:
          description: Circular reference to Field_ExtendedSectionSummary
          writeOnly: true
        valueType:
          type: string
        global:
          type: boolean
        requiresUniqueValue:
          type: boolean
        parameterizedCurrentValues:
          type: array
          items:
            $ref: '#/components/schemas/CurrentValueObject_ExtendedSectionSummary'
          writeOnly: true
        analysisOutputField:
          type: boolean
        discrete:
          type: boolean
        currentValuesFromOtherField:
          description: Circular reference to Field_ExtendedSectionSummary
          writeOnly: true
        formatForNumberDisplayingFields:
          description: Circular reference to Field_ExtendedSectionSummary
          writeOnly: true
        crossWorkflowCalculation:
          type: boolean
        validTypeForCalculationInput:
          type: boolean
      required:
        - active
        - analysisEstimate
        - analysisType
        - convertibleTo
        - copyRecordAccessField
        - created
        - currency
        - currentValues
        - defaultValues
        - enabledForRecordAccess
        - fieldType
        - format
        - helpText
        - id
        - label
        - labels
        - name
        - operators
        - tooltip
        - updated
    FormSection_ExtendedSectionSummary:
      allOf:
        - description: Circular reference to Section_ExtendedSectionSummary
        - type: object
          properties:
            numberOfColumns:
              type: integer
              format: int32
            readOnly:
              type: boolean
      required:
        - active
        - collapsed
        - color
        - colspan
        - conditionsEnabled
        - conditionsUseAndOperator
        - created
        - defaultState
        - guidance
        - icon
        - id
        - name
        - numberOfColumns
        - parentId
        - priority
        - readOnly
        - step
        - stepId
        - updated
    Step_ExtendedSectionSummary:
      type: object
      description: An entity to store details about a specific step within a workflow
      discriminator:
        propertyName: stepType
      oneOf:
        - $ref: '#/components/schemas/Origin_ExtendedSectionSummary'
        - description: >-
            And other types: Chain_ExtendedSectionSummary,
            End_ExtendedSectionSummary, Origin_ExtendedSectionSummary,
            Chain_ExtendedSectionSummary, End_ExtendedSectionSummary
      properties:
        stepType:
          type: string
          description: >-
            Step type. Advisory on writes. The server resolves the persisted
            step's type from the step id and ignores any client-supplied value.
          enum:
            - ORIGIN
            - CHAIN
            - END
        name:
          type: string
          description: Step name.
        description:
          type: string
          description: Description of the step.
        priority:
          type: integer
          format: int32
          description: >-
            Determines the step's place in the workflow. Priority is in
            descending order with 0 being the first step.
        userGroupOperationType:
          type: string
          description: >-
            Determine how users are able to interact with user groups on the
            step. By default, new steps will allow FULL_ACCESS user group
            editing.
          enum:
            - FULL_ACCESS
            - ADD_ONLY
            - READ_ONLY
        xpos:
          type: integer
          format: int32
          description: Vertical position of the step on the process screen.
        ypos:
          type: integer
          format: int32
          description: Horizontal position of the step on the process screen.
        commentsEnabled:
          type: boolean
          description: Allows comments to be displayed on a step.
        documentsEnabled:
          type: boolean
          description: Allows documents to be generated on a step.
        externalUserMfaRequired:
          type: boolean
          description: >-
            Whether or not to require MFA for external users to access this
            step.
        uxriEnabled:
          type: boolean
          description: Whether or not to enable UXRI on the step.
        autofillEnabled:
          type: boolean
          description: Whether or not to enable autofill on the step.
        sla:
          $ref: '#/components/schemas/ServiceLevelAgreement_ExtendedSectionSummary'
          description: Object containing all SLA information.
        assignableUserType:
          type: string
          description: >-
            Determine what users are able to be assigned to a record. By
            default, new records will allow APP_USERS as assignees.
          enum:
            - APP_AND_EXTERNAL_USERS
            - APP_USERS
            - EXTERNAL_USERS
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        end:
          type: boolean
        contains:
          description: Circular reference to Step_ExtendedSectionSummary
          writeOnly: true
        origin:
          type: boolean
        chain:
          type: boolean
      required:
        - active
        - assignableUserType
        - autofillEnabled
        - commentsEnabled
        - created
        - description
        - documentsEnabled
        - externalUserMfaRequired
        - id
        - name
        - priority
        - sla
        - stepType
        - updated
        - userGroupOperationType
        - uxriEnabled
        - xpos
        - ypos
    Text_ExtendedSectionSummary:
      allOf:
        - description: Circular reference to Field_ExtendedSectionSummary
      required:
        - fieldType
    CurrentValue_ExtendedSectionSummary:
      type: object
      description: Entity used to manage record's field data.
      discriminator:
        propertyName: discriminator
      oneOf:
        - $ref: '#/components/schemas/CurrentCommonValue_ExtendedSectionSummary'
        - description: >-
            And other types: CurrentDateValue_ExtendedSectionSummary,
            CurrentDateRangeValue_ExtendedSectionSummary,
            CurrentJobValue_ExtendedSectionSummary,
            CurrentCommonValue_ExtendedSectionSummary,
            CurrentDateValue_ExtendedSectionSummary,
            CurrentDateRangeValue_ExtendedSectionSummary,
            LabelValue_ExtendedSectionSummary,
            CleanAttachment_ExtendedSectionSummary,
            DirtyAttachment_ExtendedSectionSummary,
            PendingAttachment_ExtendedSectionSummary,
            CurrentGoogleAttachmentValue_ExtendedSectionSummary,
            CurrentSharepointAttachmentValue_ExtendedSectionSummary,
            Active_ExtendedSectionSummary, Automated_ExtendedSectionSummary,
            Disabled_ExtendedSectionSummary, External_ExtendedSectionSummary,
            Locked_ExtendedSectionSummary, Service_ExtendedSectionSummary,
            CurrentNumericRangeValue_ExtendedSectionSummary,
            CurrentJobValue_ExtendedSectionSummary
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        valueType:
          type: string
        discriminator:
          type: string
        textValue:
          type: string
        numericValue:
          type: number
          format: double
        isDefault:
          type: boolean
        archived:
          type: boolean
        priority:
          type: integer
          format: int32
        userGroup:
          type: string
          description: usergroup
        fieldId:
          type: string
        idOrTransientId:
          type: string
        transientIdOrId:
          type: string
        textOrNumericValue:
          type: string
        empty:
          type: boolean
      required:
        - active
        - archived
        - created
        - discriminator
        - id
        - isDefault
        - numericValue
        - priority
        - textValue
        - updated
        - userGroup
        - valueType
    CurrentValueObject_ExtendedSectionSummary:
      type: object
      description: Entity used to manage record's field data.
      discriminator:
        propertyName: discriminator
      oneOf:
        - description: Circular reference to CurrentCommonValue_ExtendedSectionSummary
        - description: >-
            And other types: CurrentDateValue_ExtendedSectionSummary,
            CurrentDateRangeValue_ExtendedSectionSummary,
            CurrentJobValue_ExtendedSectionSummary,
            CurrentCommonValue_ExtendedSectionSummary,
            CurrentDateValue_ExtendedSectionSummary,
            CurrentDateRangeValue_ExtendedSectionSummary,
            LabelValue_ExtendedSectionSummary,
            CleanAttachment_ExtendedSectionSummary,
            DirtyAttachment_ExtendedSectionSummary,
            PendingAttachment_ExtendedSectionSummary,
            CurrentGoogleAttachmentValue_ExtendedSectionSummary,
            CurrentSharepointAttachmentValue_ExtendedSectionSummary,
            Active_ExtendedSectionSummary, Automated_ExtendedSectionSummary,
            Disabled_ExtendedSectionSummary, External_ExtendedSectionSummary,
            Locked_ExtendedSectionSummary, Service_ExtendedSectionSummary,
            CurrentNumericRangeValue_ExtendedSectionSummary,
            CurrentJobValue_ExtendedSectionSummary
      properties:
        id:
          type: string
        active:
          type: boolean
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
        valueType:
          type: string
        discriminator:
          type: string
        textValue:
          type: string
        numericValue:
          type: number
          format: double
        isDefault:
          type: boolean
        archived:
          type: boolean
        priority:
          type: integer
          format: int32
        userGroup:
          type: string
          description: usergroup
        fieldId:
          type: string
        idOrTransientId:
          type: string
        transientIdOrId:
          type: string
        textOrNumericValue:
          type: string
        empty:
          type: boolean
      required:
        - active
        - archived
        - created
        - discriminator
        - id
        - isDefault
        - numericValue
        - priority
        - textValue
        - updated
        - userGroup
        - valueType
    Origin_ExtendedSectionSummary:
      allOf:
        - description: Circular reference to Step_ExtendedSectionSummary
    ServiceLevelAgreement_ExtendedSectionSummary:
      type: object
      properties:
        enabled:
          type: boolean
        duration:
          type: integer
          format: int64
      required:
        - duration
        - enabled
    CurrentCommonValue_ExtendedSectionSummary:
      allOf:
        - description: Circular reference to CurrentValue_ExtendedSectionSummary
        - $ref: '#/components/schemas/CurrentValueObject_ExtendedSectionSummary'
      required:
        - description
        - guidance
  securitySchemes:
    ApiToken:
      type: http
      scheme: bearer
      bearerFormat: API Token
    basic:
      type: http
      scheme: basic

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.