Address Book Contacts for Device

Returns a list of contacts for specified device

get

Path parameters

tenantVarCodestringRequired

Tenant Var Code

deviceIdstringRequired

Device Id

Responses

200

OK

ContactIdstring · nullableOptional

Unique string that identifies the contact

ContactNamestring · min: 1Required

A string with contact name

IsEscalationContactbooleanOptional

In the event of an emergency, escalation contact information will be provided to first responders. Applicable to Tenant contacts only.

AppliesToSubtenantsbooleanOptional

Makes tenant contact available also for sub-tenants. Applicable to Tenant contacts only.

SyncToDevicesboolean · nullableOptional

Contact is synced to devices. Read only property applicable to Tenant contacts only.

CultureNamestring · nullableOptional

Optionally denotes the Culture for the contact.

get/V2/{tenantVarCode}/devices/{deviceId}/addressbookcontacts

GET /V2/{tenantVarCode}/devices/{deviceId}/addressbookcontacts HTTP/1.1
Accept: */*

200

OK

[
  {
    "ContactId": "text",
    "ContactName": "text",
    "IsEscalationContact": true,
    "AppliesToSubtenants": true,
    "SyncToDevices": true,
    "CultureName": "text",
    "ContactEntries": [
      {
        "EntryId": "text",
        "Address": "text",
        "LastUpdated": "2026-01-01T00:00:00.000Z"
      }
    ]
  }
]

Creates a new device contact

post

Path parameters

tenantVarCodestringRequired

Tenant Var Code

deviceIdstringRequired

Device Id

Body

ContactIdstring · nullableOptional

Unique string that identifies the contact

ContactNamestring · min: 1Required

A string with contact name

IsEscalationContactbooleanOptional

In the event of an emergency, escalation contact information will be provided to first responders. Applicable to Tenant contacts only.

AppliesToSubtenantsbooleanOptional

Makes tenant contact available also for sub-tenants. Applicable to Tenant contacts only.

SyncToDevicesboolean · nullableOptional

Contact is synced to devices. Read only property applicable to Tenant contacts only.

CultureNamestring · nullableOptional

Optionally denotes the Culture for the contact.

Responses

200

OK

No content

post/V2/{tenantVarCode}/devices/{deviceId}/addressbookcontacts

POST /V2/{tenantVarCode}/devices/{deviceId}/addressbookcontacts HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 233

{
  "ContactId": "text",
  "ContactName": "text",
  "IsEscalationContact": true,
  "AppliesToSubtenants": true,
  "SyncToDevices": true,
  "CultureName": "text",
  "ContactEntries": [
    {
      "EntryId": "text",
      "Address": "text",
      "LastUpdated": "2026-01-01T00:00:00.000Z"
    }
  ]
}

200

OK

No content

Returns a specific contact

get

Path parameters

tenantVarCodestringRequired

Tenant Var Code

deviceIdstringRequired

Device Id

contactIdstringRequired

Contact Id

Responses

200

OK

ContactIdstring · nullableOptional

Unique string that identifies the contact

ContactNamestring · min: 1Required

A string with contact name

IsEscalationContactbooleanOptional

In the event of an emergency, escalation contact information will be provided to first responders. Applicable to Tenant contacts only.

AppliesToSubtenantsbooleanOptional

Makes tenant contact available also for sub-tenants. Applicable to Tenant contacts only.

SyncToDevicesboolean · nullableOptional

Contact is synced to devices. Read only property applicable to Tenant contacts only.

CultureNamestring · nullableOptional

Optionally denotes the Culture for the contact.

get/V2/{tenantVarCode}/devices/{deviceId}/addressbookcontacts/{contactId}

GET /V2/{tenantVarCode}/devices/{deviceId}/addressbookcontacts/{contactId} HTTP/1.1
Accept: */*

200

OK

{
  "ContactId": "text",
  "ContactName": "text",
  "IsEscalationContact": true,
  "AppliesToSubtenants": true,
  "SyncToDevices": true,
  "CultureName": "text",
  "ContactEntries": [
    {
      "EntryId": "text",
      "Address": "text",
      "LastUpdated": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Updates an existing device contact

put

Path parameters

tenantVarCodestringRequired

Tenant Var Code

deviceIdstringRequired

Device Id

contactIdstringRequired

Contact Id

Body

ContactIdstring · nullableOptional

Unique string that identifies the contact

ContactNamestring · min: 1Required

A string with contact name

IsEscalationContactbooleanOptional

In the event of an emergency, escalation contact information will be provided to first responders. Applicable to Tenant contacts only.

AppliesToSubtenantsbooleanOptional

Makes tenant contact available also for sub-tenants. Applicable to Tenant contacts only.

SyncToDevicesboolean · nullableOptional

Contact is synced to devices. Read only property applicable to Tenant contacts only.

CultureNamestring · nullableOptional

Optionally denotes the Culture for the contact.

Responses

200

OK

No content

put/V2/{tenantVarCode}/devices/{deviceId}/addressbookcontacts/{contactId}

PUT /V2/{tenantVarCode}/devices/{deviceId}/addressbookcontacts/{contactId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 233

{
  "ContactId": "text",
  "ContactName": "text",
  "IsEscalationContact": true,
  "AppliesToSubtenants": true,
  "SyncToDevices": true,
  "CultureName": "text",
  "ContactEntries": [
    {
      "EntryId": "text",
      "Address": "text",
      "LastUpdated": "2026-01-01T00:00:00.000Z"
    }
  ]
}

200

OK

No content

Deletes a specific device contact

delete

Path parameters

tenantVarCodestringRequired

deviceIdstringRequired

Device Id

contactIdstringRequired

Contact Id

Responses

200

OK

No content

delete/V2/{tenantVarCode}/devices/{deviceId}/addressbookcontacts/{contactId}

DELETE /V2/{tenantVarCode}/devices/{deviceId}/addressbookcontacts/{contactId} HTTP/1.1
Accept: */*

200

OK

No content