---
updatedAt: 2026-06-12T21:24:56.000Z
agentTools:
  projectIndex: https://cloud.docs.tamr.com/llms.txt
---

# create external id

Create an external id.

**Note:** To use the Try It feature on the right to see an example response, you can enter any values for the required parameters.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "ExternalIds",
    "version": "v1alpha1"
  },
  "tags": [
    {
      "name": "tamr.api.v1alpha1.ExternalIds"
    }
  ],
  "paths": {
    "/api/v1alpha1/tables/{tableId}/externalIds": {
      "post": {
        "summary": "create external id",
        "description": "Create an external id.",
        "operationId": "ExternalIds_CreateExternalId",
        "responses": {
          "200": {
            "description": "A successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/tamr.api.v1alpha1.CreateExternalIdResponse"
                }
              }
            }
          }
        },
        "parameters": [
          {
            "name": "tableId",
            "description": "Required. The table that the external ID will belong to.",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/tamr.api.v1alpha1.ExternalIds.CreateExternalIdBody"
              }
            }
          },
          "required": true
        },
        "tags": [
          "tamr.api.v1alpha1.ExternalIds"
        ]
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "X-API-KEY",
        "value": "example-api-key"
      }
    ]
  },
  "servers": [
    {
      "url": "https://api-examples.tamr.cloud"
    }
  ],
  "components": {
    "schemas": {
      "tamr.api.v1alpha1.CreateExternalIdResponse": {
        "type": "object",
        "properties": {
          "externalId": {
            "description": "The created external ID mapping.",
            "allOf": [
              {
                "$ref": "#/components/schemas/tamr.api.v1alpha1.ExternalId"
              }
            ]
          }
        },
        "description": "Response message for CreateExternalId method."
      },
      "tamr.api.v1alpha1.ExternalId": {
        "type": "object",
        "properties": {
          "externalId": {
            "type": "string",
            "description": "The external ID."
          },
          "tableId": {
            "type": "string",
            "description": "The table that the external ID belongs to."
          },
          "recordId": {
            "type": "string",
            "description": "The record ID that this external ID maps to."
          },
          "versionId": {
            "type": "string",
            "format": "int64",
            "description": "Output only. The current version of the external ID.",
            "readOnly": true
          },
          "timestamp": {
            "type": "string",
            "format": "date-time",
            "description": "Output only. The time when the external id was last updated.",
            "readOnly": true
          }
        },
        "description": "Represents an external ID mapping to a record."
      },
      "tamr.api.v1alpha1.ExternalIds.CreateExternalIdBody": {
        "type": "object",
        "properties": {
          "recordId": {
            "type": "string",
            "description": "Required. The record ID that this external ID will map to."
          },
          "externalId": {
            "type": "string",
            "description": "Required. The external ID to create."
          }
        },
        "description": "Request message for CreateExternalId method.",
        "required": [
          "recordId",
          "externalId"
        ]
      }
    }
  }
}
```