v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

Add External ID Info for an Entity

post/v1/external_ids

Query parameters

external_idstring

Denotes the ID provided by an external integration.

integration_namestring

Denotes the integration with which the external_id is associated.

external_id_holder_idinteger

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_typestring

Type of the external ID holder. Allowed values are: <ul><li>User</li><li>Vehicle</li><li>Asset</li><li>Group</li></ul>

Response

200

Example response

{
  "external_id": {
    "id": 809946,
    "external_id": "112233",
    "integration_name": "INT",
    "external_id_holder_id": 3314385,
    "external_id_holder_type": "User"
  }
}