POST v1/{subscriptionID}/projects/{projectID}/masterList

Creates a new master list and associates it with a specified project ID.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
subscriptionID

The Circle subscription ID.

globally unique identifier

Required

projectID

The project ID.

globally unique identifier

Required

Body Parameters

The master list to be created.

MasterListModel
NameDescriptionTypeAdditional information
SubscriptionID

Gets the subscription ID of the master list.

globally unique identifier

None.

ProjectID

Gets the project ID of the master list.

globally unique identifier

None.

CreationTime

Gets the creation time of the master list.

date

None.

Creator

Gets the user who created the master list.

UserViewModel

None.

ModificationTime

Gets the last modification time of the master list.

date

None.

Modifier

Gets the user who was th last to modify the master list.

UserViewModel

None.

FilterType

Gets and sets the recipient filter type of the master list.

RecipientFilterType

None.

FilterValue

Gets and sets the recipient filter value of the master list.

string

None.

DataSourceID

Gets and sets the recipient data source ID of the master list.

globally unique identifier

None.

AdditionalDataSources

Gets and sets the additional data sources of the master list.

Collection of AdditionalDataSourceModel

None.

Request Formats

application/json, text/json

Sample:
{
  "SubscriptionID": "4b6692ce-b2f5-40c7-9b6b-48ef80b05e4b",
  "ProjectID": "58c09d31-fd8d-4a9c-bb62-8fbf65573a29",
  "CreationTime": "2021-12-02T21:02:37.5949751Z",
  "Creator": {
    "ID": "e0ef6e95-9ddc-423d-ae79-f05113454211",
    "Name": "sample string 2"
  },
  "ModificationTime": "2021-12-02T21:02:37.5949751Z",
  "Modifier": {
    "ID": "e0ef6e95-9ddc-423d-ae79-f05113454211",
    "Name": "sample string 2"
  },
  "FilterType": 1,
  "FilterValue": "sample string 5",
  "DataSource": {
    "ID": "fb21138e-5a50-4941-9968-6145e1f559d0",
    "UProduceDataSourceID": "d1c36e04-d41b-434d-b2f3-5bbadee7104c",
    "FriendlyID": "sample string 3",
    "SubscriptionID": "c9d945bc-6f97-44f0-9bd8-bf1f15f300e6",
    "IsRemote": true,
    "Name": "sample string 6",
    "CreationTime": "2021-12-02T21:02:37.5949751Z",
    "Creator": {
      "ID": "e0ef6e95-9ddc-423d-ae79-f05113454211",
      "Name": "sample string 2"
    },
    "ModificationTime": "2021-12-02T21:02:37.5949751Z",
    "Modifier": {
      "ID": "e0ef6e95-9ddc-423d-ae79-f05113454211",
      "Name": "sample string 2"
    },
    "FileToken": {
      "Token": "sample string 1",
      "Type": 1,
      "FileName": "sample string 2",
      "FileType": 1
    }
  },
  "DataSourceID": "54d69865-0f4c-4cf1-b7df-15b840c3e182",
  "AdditionalDataSources": [
    {
      "PlanDataSourceName": "sample string 1",
      "DataSourceID": "4d8a4e09-c784-49f4-a63b-df09abb71a72"
    },
    {
      "PlanDataSourceName": "sample string 1",
      "DataSourceID": "4d8a4e09-c784-49f4-a63b-df09abb71a72"
    }
  ],
  "UProducePopulationID": "abc73d8c-9bf1-4e25-8f5c-efd617350e10"
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'MasterListModel'.

Response Information

Resource Description

Returns the created master list.

MasterListModel
NameDescriptionTypeAdditional information
SubscriptionID

Gets the subscription ID of the master list.

globally unique identifier

None.

ProjectID

Gets the project ID of the master list.

globally unique identifier

None.

CreationTime

Gets the creation time of the master list.

date

None.

Creator

Gets the user who created the master list.

UserViewModel

None.

ModificationTime

Gets the last modification time of the master list.

date

None.

Modifier

Gets the user who was th last to modify the master list.

UserViewModel

None.

FilterType

Gets and sets the recipient filter type of the master list.

RecipientFilterType

None.

FilterValue

Gets and sets the recipient filter value of the master list.

string

None.

DataSourceID

Gets and sets the recipient data source ID of the master list.

globally unique identifier

None.

AdditionalDataSources

Gets and sets the additional data sources of the master list.

Collection of AdditionalDataSourceModel

None.

Response Formats

application/json, text/json

Sample:
{
  "SubscriptionID": "ae4eac33-5dee-4d69-ae81-c28a16bbde0d",
  "ProjectID": "58fb623c-9b0e-4c1e-8477-072681f45977",
  "CreationTime": "2021-12-02T21:02:37.5949751Z",
  "Creator": {
    "ID": "b0155561-81e6-4c85-b283-b0a627bac330",
    "Name": "sample string 2"
  },
  "ModificationTime": "2021-12-02T21:02:37.5949751Z",
  "Modifier": {
    "ID": "b0155561-81e6-4c85-b283-b0a627bac330",
    "Name": "sample string 2"
  },
  "FilterType": 1,
  "FilterValue": "sample string 5",
  "DataSource": {
    "ID": "ca11f7cc-165a-4078-b241-2912bf479032",
    "UProduceDataSourceID": "7467d7d9-14ac-4c11-9729-8027521d92f5",
    "FriendlyID": "sample string 3",
    "SubscriptionID": "ddca60b0-1ad4-4818-8937-79321877e328",
    "IsRemote": true,
    "Name": "sample string 6",
    "CreationTime": "2021-12-02T21:02:37.5949751Z",
    "Creator": {
      "ID": "b0155561-81e6-4c85-b283-b0a627bac330",
      "Name": "sample string 2"
    },
    "ModificationTime": "2021-12-02T21:02:37.5949751Z",
    "Modifier": {
      "ID": "b0155561-81e6-4c85-b283-b0a627bac330",
      "Name": "sample string 2"
    },
    "FileToken": {
      "Token": "sample string 1",
      "Type": 1,
      "FileName": "sample string 2",
      "FileType": 1
    }
  },
  "DataSourceID": "7b401751-6910-4629-8e8f-bc1f5a09770c",
  "AdditionalDataSources": [
    {
      "PlanDataSourceName": "sample string 1",
      "DataSourceID": "a8c78b1e-9a4f-4e5c-a830-16c7aff844a4"
    },
    {
      "PlanDataSourceName": "sample string 1",
      "DataSourceID": "a8c78b1e-9a4f-4e5c-a830-16c7aff844a4"
    }
  ],
  "UProducePopulationID": "54445d75-f2c3-4987-97d8-33a8e6f48c13"
}