Skip to content

Update a Directory Record
Deprecated

Request

⚠️ Deprecation Notice: The following endpoint is deprecated.

Updates an existing Directory Record.

Replaces the editable fields (unique identifiers, group assignment, alias, tags) on a Directory Record and returns the updated instance.

About Directory Records

A Directory Record tracks a device through the registration/approval workflow. Updating one is typically used to change its unique identifiers, reassign it to a different device group, or update its alias/tags — it does not directly change approval_status, which is system-managed.

Security
esper_cloud_api_apiKey
Path
enterprise_idstring, (uuid)required

Enterprise ID

directory_record_idstring, (uuid)required

Directory record ID

Bodyapplication/jsonrequired
unique_identifiersArray of objects(Unique Identifiers)
group_idstring, (uuid)(Group ID)
aliasstring(Alias name)
tagsArray of strings(Tags)
cURL
curl -i -X PUT \
  'https://api.esper.io/_mock/openapi/v1/enterprise/{enterprise_id}/directory_record/{directory_record_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "unique_identifiers": [
      {
        "unique_id": "string",
        "type": 0
      }
    ],
    "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
    "alias": "string",
    "tags": [
      "string"
    ]
  }'

Responses

Updated Directory Record Information

Bodyapplication/json
idstring(Directory Record ID)
namestring(Device name)
online_statusstring
Enum:"ONLINE""OFFLINE""NONE"
aliasstring(Alias name)
tagsArray of strings(Tags)
group_idstring, (uuid)(Group ID)
device_idstring, (uuid)(Device ID)
approval_statusstring(Approval Status)
Enum:"WAITING_FOR_APPROVAL""APPROVED""REJECTED""BLOCKED"
provisioned_onstring, (date-time)(Provisioned on)read-only
unique_identifiersArray of objects(Unique Identifiers)
Response
{
  "id": "string",
  "name": "string",
  "online_status": "ONLINE",
  "alias": "string",
  "tags": [
    "string"
  ],
  "group_id": "306db4e0-7449-4501-b76f-075576fe2d8f",
  "device_id": "3bafab7b-4400-4bcf-8e6e-09f954699940",
  "approval_status": "WAITING_FOR_APPROVAL",
  "provisioned_on": "2019-08-24T14:15:22Z",
  "unique_identifiers": [
    { … }
  ]
}