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

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

Request Information

URI Parameters

Name	Description	Type	Additional 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

Name	Description	Type	Additional 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": "55193c7a-3c75-4035-8070-6a1f38b05fc3",
  "ProjectID": "d34c6d04-1b9e-4db8-9184-9a34425b6133",
  "CreationTime": "2022-05-23T16:40:16.8419024Z",
  "Creator": {
    "ID": "ed12931c-8b03-41f0-8543-dcfce0dd44eb",
    "Name": "sample string 2"
  },
  "ModificationTime": "2022-05-23T16:40:16.8419024Z",
  "Modifier": {
    "ID": "ed12931c-8b03-41f0-8543-dcfce0dd44eb",
    "Name": "sample string 2"
  },
  "FilterType": 1,
  "FilterValue": "sample string 5",
  "DataSource": {
    "ID": "130781bd-23a4-46da-be01-3f69bc8c2921",
    "UProduceDataSourceID": "f112972d-c86d-4a83-92ed-e2c905533873",
    "FriendlyID": "sample string 3",
    "SubscriptionID": "374dba0e-f5d0-4290-a409-0d1aca97395c",
    "IsRemote": true,
    "Name": "sample string 6",
    "CreationTime": "2022-05-23T16:40:16.8419024Z",
    "Creator": {
      "ID": "ed12931c-8b03-41f0-8543-dcfce0dd44eb",
      "Name": "sample string 2"
    },
    "ModificationTime": "2022-05-23T16:40:16.8419024Z",
    "Modifier": {
      "ID": "ed12931c-8b03-41f0-8543-dcfce0dd44eb",
      "Name": "sample string 2"
    },
    "FileToken": {
      "Token": "sample string 1",
      "Type": 1,
      "FileName": "sample string 2",
      "FileType": 1
    }
  },
  "DataSourceID": "99544793-d1a9-4b4a-99bb-518635d5c379",
  "AdditionalDataSources": [
    {
      "PlanDataSourceName": "sample string 1",
      "DataSourceID": "742e4ae0-f1a9-4127-9630-86dd18be3dac"
    },
    {
      "PlanDataSourceName": "sample string 1",
      "DataSourceID": "742e4ae0-f1a9-4127-9630-86dd18be3dac"
    }
  ],
  "UProducePopulationID": "79c7ec52-6502-4b6f-b31d-d06d36ad20a3"
}

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

Name	Description	Type	Additional 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": "171fca81-3913-438d-8313-295a4a9ab640",
  "ProjectID": "ed611b7b-da73-4502-809e-ef4326af38fc",
  "CreationTime": "2022-05-23T16:40:16.8419024Z",
  "Creator": {
    "ID": "4780ad8a-339f-420d-96eb-d85b3a127cb1",
    "Name": "sample string 2"
  },
  "ModificationTime": "2022-05-23T16:40:16.8419024Z",
  "Modifier": {
    "ID": "4780ad8a-339f-420d-96eb-d85b3a127cb1",
    "Name": "sample string 2"
  },
  "FilterType": 1,
  "FilterValue": "sample string 5",
  "DataSource": {
    "ID": "2594cfac-5e02-4626-929e-0518333d9912",
    "UProduceDataSourceID": "f7f18d36-6e70-46fb-b3b1-3a00be37b2d2",
    "FriendlyID": "sample string 3",
    "SubscriptionID": "5d5ffe0b-a126-4acd-8875-230a7a4e3182",
    "IsRemote": true,
    "Name": "sample string 6",
    "CreationTime": "2022-05-23T16:40:16.8419024Z",
    "Creator": {
      "ID": "4780ad8a-339f-420d-96eb-d85b3a127cb1",
      "Name": "sample string 2"
    },
    "ModificationTime": "2022-05-23T16:40:16.8419024Z",
    "Modifier": {
      "ID": "4780ad8a-339f-420d-96eb-d85b3a127cb1",
      "Name": "sample string 2"
    },
    "FileToken": {
      "Token": "sample string 1",
      "Type": 1,
      "FileName": "sample string 2",
      "FileType": 1
    }
  },
  "DataSourceID": "515a3663-b3ae-463e-a02b-1d0b8bc0b271",
  "AdditionalDataSources": [
    {
      "PlanDataSourceName": "sample string 1",
      "DataSourceID": "085ff283-0f93-4483-a0d0-de7320d54311"
    },
    {
      "PlanDataSourceName": "sample string 1",
      "DataSourceID": "085ff283-0f93-4483-a0d0-de7320d54311"
    }
  ],
  "UProducePopulationID": "852b8a21-ce1d-4720-ace9-e7b05df169fc"
}