PATCH api/ElistContacts/UpdateElistContact/{Id}

Update an Elist Contact specified by its Id using a Request Body of type UpdatedElistContact.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
Id

The Id of the contact to be updated.

integer

Required

Body Parameters

A request body of type UpdatedElistContact

UpdatedElistContact
NameDescriptionTypeAdditional information
ListName

The name of the List without its domain.

string

String length: inclusive between 0 and 128

ListDisplayName

The List Display Name.

string

String length: inclusive between 0 and 255

OwnerNetID

The Cornell NetID of the Owner.

string

String length: inclusive between 0 and 50

OwnerEMailAddress

The Email Address that the owner will use when managing the list.

string

String length: inclusive between 0 and 128

OwnerDisplayName

The Display Name that will be used by the Owner when managing the list

string

String length: inclusive between 0 and 128

ListDomainName

The domain that this list will use for routing email to the appropriate list manager instance.

string

String length: inclusive between 0 and 128

Purpose

The business purpose for this list (Enumerated Value)

string

String length: inclusive between 0 and 128

SponsorNetID

The Cornell NetID for the List's Sponsor

string

String length: inclusive between 0 and 50

CornellEntity

The Cornell Entity

string

None.

Enabled

Specifies if the Contact should be Mail Enabled. When disabled the contact will not process email.

boolean

None.

Notes

A general notes field.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ListName": "sample string 1",
  "ListDisplayName": "sample string 2",
  "OwnerNetID": "sample string 3",
  "OwnerEMailAddress": "sample string 4",
  "OwnerDisplayName": "sample string 5",
  "ListDomainName": "sample string 6",
  "Purpose": "sample string 7",
  "SponsorNetID": "sample string 8",
  "CornellEntity": "sample string 9",
  "Enabled": true,
  "Notes": "sample string 11"
}

application/xml, text/xml

Sample:
<UpdatedElistContact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListServiceManagement.ViewModels">
  <CornellEntity>sample string 9</CornellEntity>
  <Enabled>true</Enabled>
  <ListDisplayName>sample string 2</ListDisplayName>
  <ListDomainName>sample string 6</ListDomainName>
  <ListName>sample string 1</ListName>
  <Notes>sample string 11</Notes>
  <OwnerDisplayName>sample string 5</OwnerDisplayName>
  <OwnerEMailAddress>sample string 4</OwnerEMailAddress>
  <OwnerNetID>sample string 3</OwnerNetID>
  <Purpose>sample string 7</Purpose>
  <SponsorNetID>sample string 8</SponsorNetID>
</UpdatedElistContact>

application/x-www-form-urlencoded

Sample:
ListName=sample+string+1&ListDisplayName=sample+string+1&OwnerNetID=sample+string+1&OwnerEMailAddress=sample+string+1&OwnerDisplayName=sample+string+1&ListDomainName=sample+string+1&Purpose=sample+string+1&SponsorNetID=sample+string+1&CornellEntity=sample+string+1&Enabled=True&Notes=sample+string+1

Response Information

Resource Description

None.