REST API - Accessing Contact Lists

Version 2

    The REST API provides access to create, retrieve, update and delete contact lists.

     

    Accessing Contact Lists

    • GET  /assets/contact/list/{id}?depth={depth}

     

    Response

    The response for this call looks as follows :

     

    {
      "type": "ContactList",
      "id": "128",
      "createdAt": "1292536642",
      "createdBy": "12",
      "depth": "complete",
      "description": "",
      "folderId": "48",
      "name": "Eloqua Employees",
      "permissions": "fullControl",
      "updatedAt": "1322752914",
      "count": "23",
      "dataLookupId": "3965b95a-9e64-42bf-9d8d-a277bf02184f",
      "scope": "global",
      "membershipAdditions": [
        "44891",
        "1479712"
      ],
      "membershipDeletions": [
        "48912"    
      ],
    }

     

    Properties

     

    Name

    Type

    Description

    Notes

    Validations

    Type"ContactList"
    CountintegerInteger
    Requirement
    dataLookupIdstring
    membershipAdditionsList of stringList of Contact IDs to be added to the listWriteOnly
    membershipDeletionsList of stringList of Contact IDs to be removed from the listWriteOnly
    scopeScopeEnum
    Requirement
    accessedAtintegerDate
    Requirement
    createdAtintegerReadOnlyDate
    Requirement
    createdByintegerReadOnlyIdRequirement
    currentStatusstring
    depthRequestDepthEnum
    Requirement
    descriptionstring
    folderIdintegerIdRequirement
    idintegerThe unique identifier for this contact listIdRequirement
    namestring
    permissionsInstance
    Permission
    Enum
    Requirement
    scheduledForintegerDate
    Requirement
    sourceTemplateIdString
    updatedAtintegerReadOnlyDate
    Requirement
    updatedByintegerReadOnlyIdRequirement

     

    Related Operations

    • POST : /assets/contact/list
    • PUT :  /assets/contact/list/{id}
    • DELETE :  /assets/contact/list/{id}
    • GET (list) :  /assets/contact/lists?depth={depth}&count={count}&page={page}&search={search}&orderBy={orderBy}&lastUpdatedAt={lastUpdatedAt}