Skip to main content

PageOfDirectories

result objectrequired
elements object[]required
  • Array [
  • directoryIdDirectoryId (string)required

    The directory ID, also known as a pool ID

    Possible values: Value must match regular expression ^POOL_\w+$

    Example: POOL_012345678901234
    nameDirectoryName (string)nullablerequired

    Possible values: <= 40 characters

    contactCountinteger<int32>required

    An approximate count of the contacts in the directory.

    isDefaultIsDefault (boolean)required
    deduplicationCriteria objectnullable
    emailDedupOnEmail (boolean)required
    firstNameDedupOnFirstName (boolean)required
    lastNameDedupOnLastName (boolean)required
    externalDataReferenceDedupOnExternalDataReference (boolean)required
    phoneDedupOnPhone (boolean)required
  • ]
  • nextPageNextPage (string)nullable
    meta objectrequired
    requestIdRequestId (string)required
    httpStatusHttpStatus (string)required
    noticeAn informational string about the request. (string)

    An informational string about the request.

    PageOfDirectories
    {
    "result": {
    "elements": [
    {
    "directoryId": "POOL_012345678901234",
    "name": "string",
    "contactCount": 0,
    "isDefault": true,
    "deduplicationCriteria": {
    "email": true,
    "firstName": true,
    "lastName": true,
    "externalDataReference": true,
    "phone": true
    }
    }
    ],
    "nextPage": "string"
    },
    "meta": {
    "requestId": "string",
    "httpStatus": "string",
    "notice": "string"
    }
    }