ListManager Email Marketing Software

Things to account for when using the new Lyris LM v11 API.

Lyris LM now validates most API input fields.  They get checked for type and length where appropriate.

  • Some calls containing bad data may now fail where they have succeeded in the past.
  • Authentication, authorization and validation occur before any work is done.
  • SelectList and UpdateList have been reimplemented.  See below for new validations.

API calls and field validation

API Function Name Field Name Required? Max Length validation authorization
(new) TMSendMessage
SqlSelect Header field mapping.
SqlInsert server admin
SqlUpdate server admin
SqlDelete server admin
CreateSingleTinyMember ListName Required
EmailAddress Required 100
CreateSingleMember EmailAddress Required 100
ListName Required accessible
CreateManyMembers ListName Required accessible
CopyMember EmailAddress Required 100
ListName Required
CreateList ListName Required 60 lowercase alphanumeric
AdminEmail Required 100
AdminName Required 100
AdminPassword 50
ShortDescription 200
DeleteList ListName can admin list
EmailOnWhatLists
EmailPasswordOnWhatLists
CreateListAdmin AdminEmail Required 100
AdminPassword Required 100
AdminListName Required
AdminFullName Required 100
ReceiveListAdminMail Required
ReceiveModerationNotification Required
BypassListModeration Required
CreateMemberBan One of Domain or UserName must be specified
Domain valid domain
UserName valid email address localPart
ListName can admin list
GetEmailFromMemberID MemberID Required can admin list
GetListID ListName Required
GetListnameFromMemberID MemberID Required can admin list
ImportContent Further work required
( 10.0 ) SelectMembersEx
SelectSimpleMembers
SendMailing Checks for disabled mode
MailingStructIn Required
SegmentID Required
MailingStatus
ScheduleMailing SendDate Required server has to be enabled
SegmentID Required
To 200
Title 70
From 200
Subject 1000
CheckForSubjectAndBodyRequirements (checking list settings for subject and body requirements and respects them)
ModerateMailing ModerateID Required server has to be enabled
Accept Required
SendRejectMessage Required
SelectLists
SelectSegments no change
SendMailingDirect MailingStructIn required server has to be enabled
SendMemberDoc DocTypeIn required server has to be enabled
TrackingSummary OutMailID required
SimpleMemberStructIn Required
Unsubscribe SimpleMemberStructArrayIn required
UpdateMemberEmail EmailAddress 100
UpdateMemberKind MemberKind Required
UpdateMemberStatus MemberStatus Required
UpdateList ListStructIn required
DefaultSubject 100
DefaultTo 200
DefaultFrom 200
Admin 50
ShortDescription 200
From 100
Keywords 200
ReplyTo 100
SMTPFrom 100
To 200
Topic 50
SubscribePassword 50
UpdateListAdmin IsListAdmin required
ReceiveListAdminMail required
ReceiveModerationNotification required
BypassListModeration required
UpdateMemberDemographics cannot update userid_
CreateMemberCOlumn FieldName required 30
DeleteMemberColumn no changes
CreateSegment ClauseWhere required server admin if GetSegmentPermissionSetting flag is = 2
SegmentName required 60
Description required 90
ListName required
UpdateSegment Description 90
ClauseWhere required
DeleteSegment server admin if GetSegmentPermissionSetting flag is = 2
SendMessage ListName Required server has to be enabled
Body Not required
CheckForSubjectAndBodyRequirements (checking list settings for subject and body requirements and respects them)