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



## OpenAPI

````yaml /openapi/rest/openapi-v3-ForeignApp.json delete /api/v1/ForeignApp/{applicationName}/{deviceName}/{deviceIdentifier}/Key/{keyName}/{tableName}/{recordId}
openapi: 3.0.0
info:
  version: v1-REST
  title: SuperOffice REST API v1
  description: SuperOffice REST API - ForeignApp
  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/ForeignApp/{applicationName}/{deviceName}/{deviceIdentifier}/Key/{keyName}/{tableName}/{recordId}:
    delete:
      tags:
        - ForeignApp
      summary: Delete Foreign Key On Name
      description: >-
        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.
      operationId: v1ForeignAppEntity_DeleteForeignKeyOnName
      parameters:
        - name: applicationName
          in: path
          description: The name of the foreign application.
          required: true
          schema:
            type: string
        - name: deviceName
          in: path
          description: The name of the foreign device.
          required: true
          schema:
            type: string
        - name: keyName
          in: path
          description: The name of the foreign key to delete.
          required: true
          schema:
            type: string
        - name: deviceIdentifier
          in: path
          description: The device identifier. Optional if device identifier is not used.
          required: true
          schema:
            type: string
        - name: tableName
          in: path
          description: >-
            Table name, transformed to and from numeric table id by the service
            layer.<p/>Use an empty string to delete ALL keys that otherwise
            match; this may be dangerous and can take a long time if there are
            many items to delete.
          required: true
          schema:
            type: string
        - name: recordId
          in: path
          description: >-
            Id of record that this key refers to. If the table name was blank,
            then this parameter must be 0. It can also be 0 to mean that the
            foreign key record was not bound to any particular record of the
            target table.<p/>Specifying a zero recordId will remove the recordId
            restriction and delete all keys that otherwise match.
          required: true
          schema:
            type: integer
            format: int32
        - 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:
        '204':
          description: No Content
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components: {}

````

## Related topics

- [Delete Foreign Key On Name](/en/api/reference/restful/agent/foreignsystem_agent/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)
