---
agentTools:
  projectIndex: https://developer-docs.gomotive.com/llms.txt
---

# Add External ID Info for an Entity

**Purpose**: Use this endpoint to add the external integration details of an entity. For example, if you have an existing ADP integration for running the payroll of your users, this endpoint allows you to add critical info such as the integration name, and external Id, for mapping your users between ADP and Motive. This provides for a seamless integration between the two systems.

# Response Parameters

<br />

### id

* **Type**: Integer
* **Description**: The unique identifier assigned to this external ID record.

### external\_id

* **Type**: String
* **Description**: The external ID assigned by the integration partner.

### integration\_name

* **Type**: String
* **Description**: The name of the third-party integration that provided this external ID.

### external\_id\_holder\_id

* **Type**: Integer
* **Description**: The unique identifier assigned to the entity such as a user, vehicle, asset, or a group. If your entity is a user, then enter the user ID here. If a vehicle, enter the vehicle ID. Similarly for asset (asset ID), and group (group ID).

### external\_id\_holder\_type

* **Type**: String
* **Description**: Specify the type of the holder or the entity. Allowed values are User, Vehicle, Asset, or Group.

***

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Motive",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.gomotive.com"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "in": "header",
        "name": "x-api-key"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/v1/external_ids": {
      "post": {
        "summary": "Add External ID Info for an Entity",
        "description": "",
        "operationId": "add-external-id-info-for-an-entity",
        "parameters": [
          {
            "name": "external_id",
            "in": "query",
            "description": "Denotes the ID provided by an external integration.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "integration_name",
            "in": "query",
            "description": "Denotes the integration with which the external_id is associated.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "external_id_holder_id",
            "in": "query",
            "description": "The unique identifier assigned to the entity such as a user, vehicle, asset, or a group. If your entity is a user, then enter the user ID here. If a vehicle, enter the vehicle ID. Similarly for asset (asset ID), and group (group ID).",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "external_id_holder_type",
            "in": "query",
            "description": "Type of the external ID holder. Allowed values are: <ul><li><b>User</b></li><li><b>Vehicle</b></li><li><b>Asset</b></li><li><b>Group</b></li></ul>",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "  {\n    \"external_id\": {\n        \"id\": 809946,\n        \"external_id\": \"112233\",\n        \"integration_name\": \"INT\",\n        \"external_id_holder_id\": 3314385,\n        \"external_id_holder_type\": \"User\"\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "external_id": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "integer",
                          "example": 809946,
                          "default": 0
                        },
                        "external_id": {
                          "type": "string",
                          "example": "112233"
                        },
                        "integration_name": {
                          "type": "string",
                          "example": "INT"
                        },
                        "external_id_holder_id": {
                          "type": "integer",
                          "example": 3314385,
                          "default": 0
                        },
                        "external_id_holder_type": {
                          "type": "string",
                          "example": "User"
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {}
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "66acf64a829e88001980fbf2:682f7d89f161c90015cc2def"
}
```