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

# Delete Foreign Key On Name

> Deletes all specified occurrences of a key, belonging to the ForeignApp and ForeignDevice, table and record specified.

Specifying a blank table name will delete ALL keys of the given name; specifying a recordId of 0 will delete ALL keys of the given name for the given table.
NsApiSlow threshold: 5000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-ForeignSystemAgent.json post /api/v1/Agents/ForeignSystem/DeleteForeignKeyOnName
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - ForeignSystemAgent
  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/ForeignSystem/DeleteForeignKeyOnName:
    post:
      tags:
        - ForeignSystem_Agent
      summary: Delete Foreign Key On Name
      description: "Deletes all specified occurrences of a key, belonging to the ForeignApp and ForeignDevice, table and record specified.\n\nSpecifying a blank table name will delete ALL keys of the given name; specifying a recordId of 0 will delete ALL keys of the given name for the given table.\r\nNsApiSlow threshold: 5000 ms."
      operationId: v1ForeignSystemAgent_DeleteForeignKeyOnName
      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.ForeignSystemCarriers.DeleteForeignKeyOnNameRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ForeignSystemCarriers.DeleteForeignKeyOnNameRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ForeignSystemCarriers.DeleteForeignKeyOnNameRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ForeignSystemCarriers.DeleteForeignKeyOnNameRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ForeignSystemCarriers.DeleteForeignKeyOnNameRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ForeignSystemCarriers.DeleteForeignKeyOnNameRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ForeignSystemCarriers.DeleteForeignKeyOnNameRequest
        description: >-
          ApplicationName, DeviceName, DeviceIdentifier, KeyName, TableName,
          RecordId
        required: true
      responses:
        '204':
          description: No Content
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.ForeignSystemCarriers.DeleteForeignKeyOnNameRequest:
      description: >-
        DeleteForeignKeyOnName: Deletes all specified occurrences of a key,
        belonging to the ForeignApp and ForeignDevice, table and record
        specified. Specifying a blank table name will delete ALL keys of the
        given name; specifying a recordId of 0 will delete ALL keys of the given
        name for the given table.
      type: object
      properties:
        ApplicationName:
          type: string
        DeviceName:
          type: string
        DeviceIdentifier:
          type: string
        KeyName:
          type: string
        TableName:
          type: string
        RecordId:
          format: int32
          type: integer

````

## Related topics

- [Delete Foreign Key On Name](/en/api/reference/restful/rest/foreignapp/delete-foreign-key-on-name.md)
- [SuperOffice.WebApi.Data.ForeignSystem DeleteForeignKeyOnNameRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.ForeignSystem_DeleteForeignKeyOnNameRequest.md)
- [NSForeignSystemAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSForeignSystemAgent.md)
- [SuperOffice.WebApi.Agents.ForeignSystemAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ForeignSystemAgent.md)
- [SuperOffice.WebApi.Agents.IForeignSystemAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IForeignSystemAgent.md)
- [Delete Foreign Key](/en/api/reference/restful/agent/foreignsystem_agent/delete-foreign-key.md)