PUT api/List/UpdateList?listId={listId}&isAllContacts={isAllContacts}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
listId

string

Required

isAllContacts

boolean

Default value is False

Body Parameters

ListViewModel
NameDescriptionTypeAdditional information
Name

string

None.

ListType

ListType

None.

SmartListConditions

Collection of SmartListConditionViewModel

None.

AnyAllOperator

AnyAllOperator

None.

IsFavorite

boolean

None.

AccountId

string

None.

ContactIds

Collection of string

None.

LastContactAddedDate

date

None.

Id

string

None.

CreatedDate

date

None.

UpdatedDate

date

None.

CreatedBy

string

None.

UpdatedBy

string

None.

CreatedByUserId

string

None.

UpdatedByUserId

string

None.

IsDeleted

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "ListType": "List",
  "SmartListConditions": [
    {
      "FilterBy": "Type",
      "SelectFavoriteContacts": true,
      "AnyAllOperator": "Any",
      "CategorySelectionType": "NA",
      "SmartListContactSources": "All",
      "Lists": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        }
      ],
      "Keywords": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        }
      ],
      "WebForms": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        }
      ],
      "MobilePages": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        }
      ],
      "Interests": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        }
      ],
      "Tags": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        }
      ],
      "Types": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        }
      ]
    },
    {
      "FilterBy": "Type",
      "SelectFavoriteContacts": true,
      "AnyAllOperator": "Any",
      "CategorySelectionType": "NA",
      "SmartListContactSources": "All",
      "Lists": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        }
      ],
      "Keywords": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        }
      ],
      "WebForms": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        }
      ],
      "MobilePages": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        }
      ],
      "Interests": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        }
      ],
      "Tags": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        }
      ],
      "Types": [
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        },
        {
          "Id": "sample string 1",
          "IsCategoryContactExclude": true,
          "Name": "sample string 3",
          "IsContactInCategory": true,
          "ContactCategoryFilterType": "List"
        }
      ]
    }
  ],
  "AnyAllOperator": "Any",
  "IsFavorite": true,
  "AccountId": "sample string 3",
  "ContactIds": [
    "sample string 1",
    "sample string 2"
  ],
  "LastContactAddedDate": "2024-04-18T23:51:35.0256247+00:00",
  "Id": "sample string 4",
  "CreatedDate": "2024-04-18T23:51:35.0256247+00:00",
  "UpdatedDate": "2024-04-18T23:51:35.0256247+00:00",
  "CreatedBy": "sample string 7",
  "UpdatedBy": "sample string 8",
  "CreatedByUserId": "sample string 9",
  "UpdatedByUserId": "sample string 10",
  "IsDeleted": true
}

application/xml, text/xml

Sample:
<ListViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models.ServiceModel">
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models">sample string 7</CreatedBy>
  <CreatedByUserId xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models">sample string 9</CreatedByUserId>
  <CreatedDate xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models">2024-04-18T23:51:35.0256247+00:00</CreatedDate>
  <Id xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models">sample string 4</Id>
  <IsDeleted xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models">true</IsDeleted>
  <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models">sample string 8</UpdatedBy>
  <UpdatedByUserId xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models">sample string 10</UpdatedByUserId>
  <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models">2024-04-18T23:51:35.0256247+00:00</UpdatedDate>
  <AccountId xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models">sample string 3</AccountId>
  <ContactIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ContactIds>
  <LastContactAddedDate xmlns="http://schemas.datacontract.org/2004/07/MindMe.Common.Standard.Models">2024-04-18T23:51:35.0256247+00:00</LastContactAddedDate>
  <AnyAllOperator>Any</AnyAllOperator>
  <IsFavorite>true</IsFavorite>
  <ListType>List</ListType>
  <Name>sample string 1</Name>
  <SmartListConditions>
    <SmartListConditionViewModel>
      <AnyAllOperator>Any</AnyAllOperator>
      <CategorySelectionType>NA</CategorySelectionType>
      <FilterBy>Type</FilterBy>
      <Interests>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
      </Interests>
      <Keywords>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
      </Keywords>
      <Lists>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
      </Lists>
      <MobilePages>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
      </MobilePages>
      <SelectFavoriteContacts>true</SelectFavoriteContacts>
      <SmartListContactSources>All</SmartListContactSources>
      <Tags>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
      </Tags>
      <Types>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
      </Types>
      <WebForms>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
      </WebForms>
    </SmartListConditionViewModel>
    <SmartListConditionViewModel>
      <AnyAllOperator>Any</AnyAllOperator>
      <CategorySelectionType>NA</CategorySelectionType>
      <FilterBy>Type</FilterBy>
      <Interests>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
      </Interests>
      <Keywords>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
      </Keywords>
      <Lists>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
      </Lists>
      <MobilePages>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
      </MobilePages>
      <SelectFavoriteContacts>true</SelectFavoriteContacts>
      <SmartListContactSources>All</SmartListContactSources>
      <Tags>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
      </Tags>
      <Types>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
      </Types>
      <WebForms>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
        <SmartListContactCoditionCategoryViewModel>
          <ContactCategoryFilterType>List</ContactCategoryFilterType>
          <Id>sample string 1</Id>
          <IsCategoryContactExclude>true</IsCategoryContactExclude>
          <IsContactInCategory>true</IsContactInCategory>
          <Name>sample string 3</Name>
        </SmartListContactCoditionCategoryViewModel>
      </WebForms>
    </SmartListConditionViewModel>
  </SmartListConditions>
</ListViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.