Address Book Distribution Lists for Tenant

Returns a list of global distribution lists for specified tenant

get

Path parameters

tenantVarCodestringRequired

Tenant Var Code

Responses

200

OK

SyncToDevicesbooleanOptional

Sync the distribution list to devices. This is only applicable for tenant distribution lists and for GET endpoint.

ListIdstring · nullableOptional

A unique string that identifies the distribution list

ListNamestring · min: 1Required

The name of the address book distribution list

AppliesToSubtenantsbooleanOptional

Makes tenant list available also for sub-tenants, valid for tenant distribution lists only.

LastUpdatedstring · date-time · nullableOptional

A date and time that the entry was last modified, read only.

get/V2/{tenantVarCode}/addressbookdistributionlists

GET /V2/{tenantVarCode}/addressbookdistributionlists HTTP/1.1
Accept: */*

200

OK

[
  {
    "SyncToDevices": true,
    "ListId": "text",
    "ListName": "text",
    "AppliesToSubtenants": true,
    "LastUpdated": "2026-01-01T00:00:00.000Z",
    "Recipients": [
      {
        "Type": "DeviceList",
        "TenantCode": "text",
        "ContactId": "text",
        "ContactDetailId": "text",
        "ListId": "text",
        "MessagingAddress": "text",
        "Radius": "text",
        "ReportingFrequency": "text",
        "Interval": "text",
        "GroupId": "text"
      }
    ]
  }
]

Creates a new global distribution list for the specified tenant

post

Path parameters

tenantVarCodestringRequired

Tenant Var Code

Body

ListIdstring · nullableOptional

A unique string that identifies the distribution list

ListNamestring · min: 1Required

The name of the address book distribution list

AppliesToSubtenantsbooleanOptional

Makes tenant list available also for sub-tenants, valid for tenant distribution lists only.

LastUpdatedstring · date-time · nullableOptional

A date and time that the entry was last modified, read only.

Responses

200

OK

No content

post/V2/{tenantVarCode}/addressbookdistributionlists

POST /V2/{tenantVarCode}/addressbookdistributionlists HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 325

{
  "ListId": "text",
  "ListName": "text",
  "AppliesToSubtenants": true,
  "LastUpdated": "2026-01-01T00:00:00.000Z",
  "Recipients": [
    {
      "Type": "DeviceList",
      "TenantCode": "text",
      "ContactId": "text",
      "ContactDetailId": "text",
      "ListId": "text",
      "MessagingAddress": "text",
      "Radius": "text",
      "ReportingFrequency": "text",
      "Interval": "text",
      "GroupId": "text"
    }
  ]
}

200

OK

No content

Returns a specific global distribution list

get

Path parameters

tenantVarCodestringRequired

Tenant Var Code

listIdstringRequired

List Id

Responses

200

OK

SyncToDevicesbooleanOptional

Sync the distribution list to devices. This is only applicable for tenant distribution lists and for GET endpoint.

ListIdstring · nullableOptional

A unique string that identifies the distribution list

ListNamestring · min: 1Required

The name of the address book distribution list

AppliesToSubtenantsbooleanOptional

Makes tenant list available also for sub-tenants, valid for tenant distribution lists only.

LastUpdatedstring · date-time · nullableOptional

A date and time that the entry was last modified, read only.

get/V2/{tenantVarCode}/addressbookdistributionlists/{listId}

GET /V2/{tenantVarCode}/addressbookdistributionlists/{listId} HTTP/1.1
Accept: */*

200

OK

{
  "SyncToDevices": true,
  "ListId": "text",
  "ListName": "text",
  "AppliesToSubtenants": true,
  "LastUpdated": "2026-01-01T00:00:00.000Z",
  "Recipients": [
    {
      "Type": "DeviceList",
      "TenantCode": "text",
      "ContactId": "text",
      "ContactDetailId": "text",
      "ListId": "text",
      "MessagingAddress": "text",
      "Radius": "text",
      "ReportingFrequency": "text",
      "Interval": "text",
      "GroupId": "text"
    }
  ]
}

Updates an existing global distribution list

put

Path parameters

tenantVarCodestringRequired

Tenant Var Code

listIdstringRequired

List Id

Body

ListIdstring · nullableOptional

A unique string that identifies the distribution list

ListNamestring · min: 1Required

The name of the address book distribution list

AppliesToSubtenantsbooleanOptional

Makes tenant list available also for sub-tenants, valid for tenant distribution lists only.

LastUpdatedstring · date-time · nullableOptional

A date and time that the entry was last modified, read only.

Responses

200

OK

No content

put/V2/{tenantVarCode}/addressbookdistributionlists/{listId}

PUT /V2/{tenantVarCode}/addressbookdistributionlists/{listId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 325

{
  "ListId": "text",
  "ListName": "text",
  "AppliesToSubtenants": true,
  "LastUpdated": "2026-01-01T00:00:00.000Z",
  "Recipients": [
    {
      "Type": "DeviceList",
      "TenantCode": "text",
      "ContactId": "text",
      "ContactDetailId": "text",
      "ListId": "text",
      "MessagingAddress": "text",
      "Radius": "text",
      "ReportingFrequency": "text",
      "Interval": "text",
      "GroupId": "text"
    }
  ]
}

200

OK

No content

Deletes a specific global distibution list

delete

Path parameters

tenantVarCodestringRequired

Tenant Var Code

listIdstringRequired

List Id

Responses

200

OK

No content

delete/V2/{tenantVarCode}/addressbookdistributionlists/{listId}

DELETE /V2/{tenantVarCode}/addressbookdistributionlists/{listId} HTTP/1.1
Accept: */*

200

OK

No content