POST {clientId}/Config/DistributionLists
Add Distribution Lists.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientId |
Your required clientId used to access the WebAPI. A 404 is returned if this value is invalid. |
string |
Required |
Body Parameters
Collection of DistributionLists to submit
DistributionListResult| Name | Description | Type | Additional information |
|---|---|---|---|
| DistributionLists | Collection of DistributionList |
None. |
Request Formats
application/json, text/json
Sample:
{
"DistributionLists": [
{
"DistributionListLink": 1,
"ClientLink": 2,
"Name": "sample string 3",
"Description": "sample string 4",
"ExternalUsers": [
{
"EmailAddress": "sample string 1"
}
],
"InternalUsers": [
{
"LoginID": "sample string 1"
}
]
}
]
}
application/xml, text/xml
Sample:
<DistributionListResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.Codebase.Results">
<DistributionLists xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyPreferences.REST.Models">
<d2p1:DistributionList>
<d2p1:ClientLink>2</d2p1:ClientLink>
<d2p1:Description>sample string 4</d2p1:Description>
<d2p1:DistributionListLink>1</d2p1:DistributionListLink>
<d2p1:ExternalUsers>
<d2p1:ExternalUsers>
<d2p1:EmailAddress>sample string 1</d2p1:EmailAddress>
</d2p1:ExternalUsers>
</d2p1:ExternalUsers>
<d2p1:InternalUsers>
<d2p1:InternalUsers>
<d2p1:LoginID>sample string 1</d2p1:LoginID>
</d2p1:InternalUsers>
</d2p1:InternalUsers>
<d2p1:Name>sample string 3</d2p1:Name>
</d2p1:DistributionList>
</DistributionLists>
</DistributionListResult>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Response Codes
- Unauthorized (401)
- InternalServerError (500)
- BadRequest (400)
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.