Veetro Web Service Methods
Click here for a complete list of operations.
GetMailingList
[Permission: Employee, Credentials: Sales.EmailCampaigns]
Returns Mailing List information a given ID
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /xml HTTP/1.1 Host: admin.worketc.com Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://schema.veetro.com/GetMailingList" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetMailingList xmlns="http://schema.veetro.com"> <mailingListID>int</mailingListID> </GetMailingList> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <GetMailingListResponse xmlns="http://schema.veetro.com"> <GetMailingListResult> <MailingListID>int</MailingListID> <Name>string</Name> <Tags> <Tag> <TagID>int</TagID> <Name>string</Name> <Description>string</Description> <Types>None or Entity or Lead or Journal or Project or Event or ToDo or Support_Case or Product or Subscription or Disbursement or ProductSale or Company or Person or Employee or Invoice or Quote or Workgroup or Mailing_List or Message or IsSystemTag or EntityDisabled or LeadDisabled or JournalDisabled or ProjectDisabled or EventDisabled or ToDoDisabled or SupportDisabled or ProductDisabled</Types> <Color>string</Color> <DateCreated>dateTime</DateCreated> <DateLastModified>dateTime</DateLastModified> <Remove>boolean</Remove> <Delete>boolean</Delete> </Tag> <Tag> <TagID>int</TagID> <Name>string</Name> <Description>string</Description> <Types>None or Entity or Lead or Journal or Project or Event or ToDo or Support_Case or Product or Subscription or Disbursement or ProductSale or Company or Person or Employee or Invoice or Quote or Workgroup or Mailing_List or Message or IsSystemTag or EntityDisabled or LeadDisabled or JournalDisabled or ProjectDisabled or EventDisabled or ToDoDisabled or SupportDisabled or ProductDisabled</Types> <Color>string</Color> <DateCreated>dateTime</DateCreated> <DateLastModified>dateTime</DateLastModified> <Remove>boolean</Remove> <Delete>boolean</Delete> </Tag> </Tags> <Forms> <Template> <Type>Form or Email or Letter or Invoice</Type> <TemplateID>int</TemplateID> <Notifications xsi:nil="true" /> <Name>string</Name> <Description>string</Description> <ConfirmationInfo>string</ConfirmationInfo> <OriginalFileName>string</OriginalFileName> <DateModified>dateTime</DateModified> <Html>string</Html> <Plain>string</Plain> <Subject>string</Subject> <EmailFrom>string</EmailFrom> <EmailFromName>string</EmailFromName> <Fields xsi:nil="true" /> <MailingLists xsi:nil="true" /> <MailingStarted>boolean</MailingStarted> <Flags>None or Creates_Lead_Profile or Creates_Support_Case or Auto_Archive or Group_Timesheet_Activities or Group_Timesheet_Root_Projects or Group_Timesheet_Sub_Projects or Group_Timesheet_ByDay or Label_Top_Aligned or Label_Left_Aligned or WebForm_Confirmation_Show_Text or WebForm_Confirmation_Redirect or WebForm_Creates_Account or WebForm_Captcha_On or WebForm_Captcha_Off or WebForm_Disable_Account_Updates or WebForm_Send_Confirmation_Email or WebForm_Send_Notification_Email or Login_Required or Disable_Support_Case_AutoReply or WebForm_CP_ShowAllUsers or WebForm_CP_ShowUserList or WebForm_CP_ShowUserTags or WebForm_CP_Internal</Flags> <ConfirmationConfig xsi:nil="true" /> <ObjectCreationConfig xsi:nil="true" /> <Delete>boolean</Delete> <RemoveParentLinks>boolean</RemoveParentLinks> <SubmissionCount>int</SubmissionCount> </Template> <Template> <Type>Form or Email or Letter or Invoice</Type> <TemplateID>int</TemplateID> <Notifications xsi:nil="true" /> <Name>string</Name> <Description>string</Description> <ConfirmationInfo>string</ConfirmationInfo> <OriginalFileName>string</OriginalFileName> <DateModified>dateTime</DateModified> <Html>string</Html> <Plain>string</Plain> <Subject>string</Subject> <EmailFrom>string</EmailFrom> <EmailFromName>string</EmailFromName> <Fields xsi:nil="true" /> <MailingLists xsi:nil="true" /> <MailingStarted>boolean</MailingStarted> <Flags>None or Creates_Lead_Profile or Creates_Support_Case or Auto_Archive or Group_Timesheet_Activities or Group_Timesheet_Root_Projects or Group_Timesheet_Sub_Projects or Group_Timesheet_ByDay or Label_Top_Aligned or Label_Left_Aligned or WebForm_Confirmation_Show_Text or WebForm_Confirmation_Redirect or WebForm_Creates_Account or WebForm_Captcha_On or WebForm_Captcha_Off or WebForm_Disable_Account_Updates or WebForm_Send_Confirmation_Email or WebForm_Send_Notification_Email or Login_Required or Disable_Support_Case_AutoReply or WebForm_CP_ShowAllUsers or WebForm_CP_ShowUserList or WebForm_CP_ShowUserTags or WebForm_CP_Internal</Flags> <ConfirmationConfig xsi:nil="true" /> <ObjectCreationConfig xsi:nil="true" /> <Delete>boolean</Delete> <RemoveParentLinks>boolean</RemoveParentLinks> <SubmissionCount>int</SubmissionCount> </Template> </Forms> <EntityFlags>Sales_Lead or Customer or Supplier or Subscriber or Company or Person or Employee or Do_Not_Email or Inactive or Enable_Entry_Alerts or Disable_Login or Email_Bounced or Xero_Contact or Workgroup or Disable_Owner_Alerts or QuickBooks_Contact or Has_Avatar or PermissionInheritCompany or BirthDateYearOnly</EntityFlags> <RemoveParentLinks>boolean</RemoveParentLinks> <TagsToBeRemovedWhenUnsubscribeString>string</TagsToBeRemovedWhenUnsubscribeString> <TagsToBeRemovedWhenUnsubscribe> <string>string</string> <string>string</string> </TagsToBeRemovedWhenUnsubscribe> <Delete>boolean</Delete> <SubscribersCount>int</SubscribersCount> <Flags>None or SendToCompanyPrimaryContactIfNoEmail or SubscriberContainAllTags or RemoveFromListWhenTagRemoved or RemoveTagWhenUnsubscribe</Flags> </GetMailingListResult> </GetMailingListResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /xml HTTP/1.1 Host: admin.worketc.com Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <GetMailingList xmlns="http://schema.veetro.com"> <mailingListID>int</mailingListID> </GetMailingList> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <GetMailingListResponse xmlns="http://schema.veetro.com"> <GetMailingListResult> <MailingListID>int</MailingListID> <Name>string</Name> <Tags> <Tag> <TagID>int</TagID> <Name>string</Name> <Description>string</Description> <Types>None or Entity or Lead or Journal or Project or Event or ToDo or Support_Case or Product or Subscription or Disbursement or ProductSale or Company or Person or Employee or Invoice or Quote or Workgroup or Mailing_List or Message or IsSystemTag or EntityDisabled or LeadDisabled or JournalDisabled or ProjectDisabled or EventDisabled or ToDoDisabled or SupportDisabled or ProductDisabled</Types> <Color>string</Color> <DateCreated>dateTime</DateCreated> <DateLastModified>dateTime</DateLastModified> <Remove>boolean</Remove> <Delete>boolean</Delete> </Tag> <Tag> <TagID>int</TagID> <Name>string</Name> <Description>string</Description> <Types>None or Entity or Lead or Journal or Project or Event or ToDo or Support_Case or Product or Subscription or Disbursement or ProductSale or Company or Person or Employee or Invoice or Quote or Workgroup or Mailing_List or Message or IsSystemTag or EntityDisabled or LeadDisabled or JournalDisabled or ProjectDisabled or EventDisabled or ToDoDisabled or SupportDisabled or ProductDisabled</Types> <Color>string</Color> <DateCreated>dateTime</DateCreated> <DateLastModified>dateTime</DateLastModified> <Remove>boolean</Remove> <Delete>boolean</Delete> </Tag> </Tags> <Forms> <Template> <Type>Form or Email or Letter or Invoice</Type> <TemplateID>int</TemplateID> <Notifications xsi:nil="true" /> <Name>string</Name> <Description>string</Description> <ConfirmationInfo>string</ConfirmationInfo> <OriginalFileName>string</OriginalFileName> <DateModified>dateTime</DateModified> <Html>string</Html> <Plain>string</Plain> <Subject>string</Subject> <EmailFrom>string</EmailFrom> <EmailFromName>string</EmailFromName> <Fields xsi:nil="true" /> <MailingLists xsi:nil="true" /> <MailingStarted>boolean</MailingStarted> <Flags>None or Creates_Lead_Profile or Creates_Support_Case or Auto_Archive or Group_Timesheet_Activities or Group_Timesheet_Root_Projects or Group_Timesheet_Sub_Projects or Group_Timesheet_ByDay or Label_Top_Aligned or Label_Left_Aligned or WebForm_Confirmation_Show_Text or WebForm_Confirmation_Redirect or WebForm_Creates_Account or WebForm_Captcha_On or WebForm_Captcha_Off or WebForm_Disable_Account_Updates or WebForm_Send_Confirmation_Email or WebForm_Send_Notification_Email or Login_Required or Disable_Support_Case_AutoReply or WebForm_CP_ShowAllUsers or WebForm_CP_ShowUserList or WebForm_CP_ShowUserTags or WebForm_CP_Internal</Flags> <ConfirmationConfig xsi:nil="true" /> <ObjectCreationConfig xsi:nil="true" /> <Delete>boolean</Delete> <RemoveParentLinks>boolean</RemoveParentLinks> <SubmissionCount>int</SubmissionCount> </Template> <Template> <Type>Form or Email or Letter or Invoice</Type> <TemplateID>int</TemplateID> <Notifications xsi:nil="true" /> <Name>string</Name> <Description>string</Description> <ConfirmationInfo>string</ConfirmationInfo> <OriginalFileName>string</OriginalFileName> <DateModified>dateTime</DateModified> <Html>string</Html> <Plain>string</Plain> <Subject>string</Subject> <EmailFrom>string</EmailFrom> <EmailFromName>string</EmailFromName> <Fields xsi:nil="true" /> <MailingLists xsi:nil="true" /> <MailingStarted>boolean</MailingStarted> <Flags>None or Creates_Lead_Profile or Creates_Support_Case or Auto_Archive or Group_Timesheet_Activities or Group_Timesheet_Root_Projects or Group_Timesheet_Sub_Projects or Group_Timesheet_ByDay or Label_Top_Aligned or Label_Left_Aligned or WebForm_Confirmation_Show_Text or WebForm_Confirmation_Redirect or WebForm_Creates_Account or WebForm_Captcha_On or WebForm_Captcha_Off or WebForm_Disable_Account_Updates or WebForm_Send_Confirmation_Email or WebForm_Send_Notification_Email or Login_Required or Disable_Support_Case_AutoReply or WebForm_CP_ShowAllUsers or WebForm_CP_ShowUserList or WebForm_CP_ShowUserTags or WebForm_CP_Internal</Flags> <ConfirmationConfig xsi:nil="true" /> <ObjectCreationConfig xsi:nil="true" /> <Delete>boolean</Delete> <RemoveParentLinks>boolean</RemoveParentLinks> <SubmissionCount>int</SubmissionCount> </Template> </Forms> <EntityFlags>Sales_Lead or Customer or Supplier or Subscriber or Company or Person or Employee or Do_Not_Email or Inactive or Enable_Entry_Alerts or Disable_Login or Email_Bounced or Xero_Contact or Workgroup or Disable_Owner_Alerts or QuickBooks_Contact or Has_Avatar or PermissionInheritCompany or BirthDateYearOnly</EntityFlags> <RemoveParentLinks>boolean</RemoveParentLinks> <TagsToBeRemovedWhenUnsubscribeString>string</TagsToBeRemovedWhenUnsubscribeString> <TagsToBeRemovedWhenUnsubscribe> <string>string</string> <string>string</string> </TagsToBeRemovedWhenUnsubscribe> <Delete>boolean</Delete> <SubscribersCount>int</SubscribersCount> <Flags>None or SendToCompanyPrimaryContactIfNoEmail or SubscriberContainAllTags or RemoveFromListWhenTagRemoved or RemoveTagWhenUnsubscribe</Flags> </GetMailingListResult> </GetMailingListResponse> </soap12:Body> </soap12:Envelope>
HTTP GET
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /xml/GetMailingList?mailingListID=string HTTP/1.1 Host: admin.worketc.com
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <MailingList xmlns="http://schema.veetro.com"> <MailingListID>int</MailingListID> <Name>string</Name> <Tags> <Tag> <TagID>int</TagID> <Name>string</Name> <Description>string</Description> <Types>None or Entity or Lead or Journal or Project or Event or ToDo or Support_Case or Product or Subscription or Disbursement or ProductSale or Company or Person or Employee or Invoice or Quote or Workgroup or Mailing_List or Message or IsSystemTag or EntityDisabled or LeadDisabled or JournalDisabled or ProjectDisabled or EventDisabled or ToDoDisabled or SupportDisabled or ProductDisabled</Types> <Color>string</Color> <DateCreated>dateTime</DateCreated> <DateLastModified>dateTime</DateLastModified> <Remove>boolean</Remove> <Delete>boolean</Delete> </Tag> <Tag> <TagID>int</TagID> <Name>string</Name> <Description>string</Description> <Types>None or Entity or Lead or Journal or Project or Event or ToDo or Support_Case or Product or Subscription or Disbursement or ProductSale or Company or Person or Employee or Invoice or Quote or Workgroup or Mailing_List or Message or IsSystemTag or EntityDisabled or LeadDisabled or JournalDisabled or ProjectDisabled or EventDisabled or ToDoDisabled or SupportDisabled or ProductDisabled</Types> <Color>string</Color> <DateCreated>dateTime</DateCreated> <DateLastModified>dateTime</DateLastModified> <Remove>boolean</Remove> <Delete>boolean</Delete> </Tag> </Tags> <Forms> <Template> <Type>Form or Email or Letter or Invoice</Type> <TemplateID>int</TemplateID> <Notifications> <Person d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <Person d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </Notifications> <Name>string</Name> <Description>string</Description> <ConfirmationInfo>string</ConfirmationInfo> <OriginalFileName>string</OriginalFileName> <DateModified>dateTime</DateModified> <Html>string</Html> <Plain>string</Plain> <Subject>string</Subject> <EmailFrom>string</EmailFrom> <EmailFromName>string</EmailFromName> <Fields> <Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </Fields> <MailingLists> <MailingList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <MailingList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </MailingLists> <MailingStarted>boolean</MailingStarted> <Flags>None or Creates_Lead_Profile or Creates_Support_Case or Auto_Archive or Group_Timesheet_Activities or Group_Timesheet_Root_Projects or Group_Timesheet_Sub_Projects or Group_Timesheet_ByDay or Label_Top_Aligned or Label_Left_Aligned or WebForm_Confirmation_Show_Text or WebForm_Confirmation_Redirect or WebForm_Creates_Account or WebForm_Captcha_On or WebForm_Captcha_Off or WebForm_Disable_Account_Updates or WebForm_Send_Confirmation_Email or WebForm_Send_Notification_Email or Login_Required or Disable_Support_Case_AutoReply or WebForm_CP_ShowAllUsers or WebForm_CP_ShowUserList or WebForm_CP_ShowUserTags or WebForm_CP_Internal</Flags> <ConfirmationConfig> <EmailFrom>string</EmailFrom> <EmailFromName>string</EmailFromName> <Subject>string</Subject> <Html>string</Html> </ConfirmationConfig> <ObjectCreationConfig> <Lead_Name>string</Lead_Name> <Lead_DefaultName>string</Lead_DefaultName> <Lead_Source>string</Lead_Source> <Lead_Owner>int</Lead_Owner> <Lead_SalesProcess>int</Lead_SalesProcess> <Lead_ProbabilityPercent>int</Lead_ProbabilityPercent> <Lead_Referrer>int</Lead_Referrer> <Lead_Description>string</Lead_Description> <SupportCase_Owner>int</SupportCase_Owner> <SupportCase_Name>string</SupportCase_Name> <SupportCase_DefaultName>string</SupportCase_DefaultName> <SupportCase_Status>int</SupportCase_Status> <SupportCase_Priority>int</SupportCase_Priority> <SupportCase_Type>int</SupportCase_Type> <SupportCase_Description>string</SupportCase_Description> <Contact_Tags d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <Contact_New_Option>int</Contact_New_Option> <Contact_New_TagApplyNewContacts>boolean</Contact_New_TagApplyNewContacts> <Contact_New_TagApplyExisting>boolean</Contact_New_TagApplyExisting> <CP_Client_Ids d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CP_Client_Tags d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CP_Client_TagIDs d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <SubmitButtonText>string</SubmitButtonText> <Campaign_Progress d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <Campaign_DateRefreshed>dateTime</Campaign_DateRefreshed> </ObjectCreationConfig> <Delete>boolean</Delete> <RemoveParentLinks>boolean</RemoveParentLinks> <SubmissionCount>int</SubmissionCount> </Template> <Template> <Type>Form or Email or Letter or Invoice</Type> <TemplateID>int</TemplateID> <Notifications> <Person d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <Person d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </Notifications> <Name>string</Name> <Description>string</Description> <ConfirmationInfo>string</ConfirmationInfo> <OriginalFileName>string</OriginalFileName> <DateModified>dateTime</DateModified> <Html>string</Html> <Plain>string</Plain> <Subject>string</Subject> <EmailFrom>string</EmailFrom> <EmailFromName>string</EmailFromName> <Fields> <Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </Fields> <MailingLists> <MailingList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <MailingList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </MailingLists> <MailingStarted>boolean</MailingStarted> <Flags>None or Creates_Lead_Profile or Creates_Support_Case or Auto_Archive or Group_Timesheet_Activities or Group_Timesheet_Root_Projects or Group_Timesheet_Sub_Projects or Group_Timesheet_ByDay or Label_Top_Aligned or Label_Left_Aligned or WebForm_Confirmation_Show_Text or WebForm_Confirmation_Redirect or WebForm_Creates_Account or WebForm_Captcha_On or WebForm_Captcha_Off or WebForm_Disable_Account_Updates or WebForm_Send_Confirmation_Email or WebForm_Send_Notification_Email or Login_Required or Disable_Support_Case_AutoReply or WebForm_CP_ShowAllUsers or WebForm_CP_ShowUserList or WebForm_CP_ShowUserTags or WebForm_CP_Internal</Flags> <ConfirmationConfig> <EmailFrom>string</EmailFrom> <EmailFromName>string</EmailFromName> <Subject>string</Subject> <Html>string</Html> </ConfirmationConfig> <ObjectCreationConfig> <Lead_Name>string</Lead_Name> <Lead_DefaultName>string</Lead_DefaultName> <Lead_Source>string</Lead_Source> <Lead_Owner>int</Lead_Owner> <Lead_SalesProcess>int</Lead_SalesProcess> <Lead_ProbabilityPercent>int</Lead_ProbabilityPercent> <Lead_Referrer>int</Lead_Referrer> <Lead_Description>string</Lead_Description> <SupportCase_Owner>int</SupportCase_Owner> <SupportCase_Name>string</SupportCase_Name> <SupportCase_DefaultName>string</SupportCase_DefaultName> <SupportCase_Status>int</SupportCase_Status> <SupportCase_Priority>int</SupportCase_Priority> <SupportCase_Type>int</SupportCase_Type> <SupportCase_Description>string</SupportCase_Description> <Contact_Tags d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <Contact_New_Option>int</Contact_New_Option> <Contact_New_TagApplyNewContacts>boolean</Contact_New_TagApplyNewContacts> <Contact_New_TagApplyExisting>boolean</Contact_New_TagApplyExisting> <CP_Client_Ids d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CP_Client_Tags d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CP_Client_TagIDs d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <SubmitButtonText>string</SubmitButtonText> <Campaign_Progress d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <Campaign_DateRefreshed>dateTime</Campaign_DateRefreshed> </ObjectCreationConfig> <Delete>boolean</Delete> <RemoveParentLinks>boolean</RemoveParentLinks> <SubmissionCount>int</SubmissionCount> </Template> </Forms> <EntityFlags>Sales_Lead or Customer or Supplier or Subscriber or Company or Person or Employee or Do_Not_Email or Inactive or Enable_Entry_Alerts or Disable_Login or Email_Bounced or Xero_Contact or Workgroup or Disable_Owner_Alerts or QuickBooks_Contact or Has_Avatar or PermissionInheritCompany or BirthDateYearOnly</EntityFlags> <RemoveParentLinks>boolean</RemoveParentLinks> <TagsToBeRemovedWhenUnsubscribeString>string</TagsToBeRemovedWhenUnsubscribeString> <TagsToBeRemovedWhenUnsubscribe> <string>string</string> <string>string</string> </TagsToBeRemovedWhenUnsubscribe> <Delete>boolean</Delete> <SubscribersCount>int</SubscribersCount> <Flags>None or SendToCompanyPrimaryContactIfNoEmail or SubscriberContainAllTags or RemoveFromListWhenTagRemoved or RemoveTagWhenUnsubscribe</Flags> </MailingList>
HTTP POST
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /xml/GetMailingList HTTP/1.1 Host: admin.worketc.com Content-Type: application/x-www-form-urlencoded Content-Length: length mailingListID=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <MailingList xmlns="http://schema.veetro.com"> <MailingListID>int</MailingListID> <Name>string</Name> <Tags> <Tag> <TagID>int</TagID> <Name>string</Name> <Description>string</Description> <Types>None or Entity or Lead or Journal or Project or Event or ToDo or Support_Case or Product or Subscription or Disbursement or ProductSale or Company or Person or Employee or Invoice or Quote or Workgroup or Mailing_List or Message or IsSystemTag or EntityDisabled or LeadDisabled or JournalDisabled or ProjectDisabled or EventDisabled or ToDoDisabled or SupportDisabled or ProductDisabled</Types> <Color>string</Color> <DateCreated>dateTime</DateCreated> <DateLastModified>dateTime</DateLastModified> <Remove>boolean</Remove> <Delete>boolean</Delete> </Tag> <Tag> <TagID>int</TagID> <Name>string</Name> <Description>string</Description> <Types>None or Entity or Lead or Journal or Project or Event or ToDo or Support_Case or Product or Subscription or Disbursement or ProductSale or Company or Person or Employee or Invoice or Quote or Workgroup or Mailing_List or Message or IsSystemTag or EntityDisabled or LeadDisabled or JournalDisabled or ProjectDisabled or EventDisabled or ToDoDisabled or SupportDisabled or ProductDisabled</Types> <Color>string</Color> <DateCreated>dateTime</DateCreated> <DateLastModified>dateTime</DateLastModified> <Remove>boolean</Remove> <Delete>boolean</Delete> </Tag> </Tags> <Forms> <Template> <Type>Form or Email or Letter or Invoice</Type> <TemplateID>int</TemplateID> <Notifications> <Person d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <Person d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </Notifications> <Name>string</Name> <Description>string</Description> <ConfirmationInfo>string</ConfirmationInfo> <OriginalFileName>string</OriginalFileName> <DateModified>dateTime</DateModified> <Html>string</Html> <Plain>string</Plain> <Subject>string</Subject> <EmailFrom>string</EmailFrom> <EmailFromName>string</EmailFromName> <Fields> <Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </Fields> <MailingLists> <MailingList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <MailingList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </MailingLists> <MailingStarted>boolean</MailingStarted> <Flags>None or Creates_Lead_Profile or Creates_Support_Case or Auto_Archive or Group_Timesheet_Activities or Group_Timesheet_Root_Projects or Group_Timesheet_Sub_Projects or Group_Timesheet_ByDay or Label_Top_Aligned or Label_Left_Aligned or WebForm_Confirmation_Show_Text or WebForm_Confirmation_Redirect or WebForm_Creates_Account or WebForm_Captcha_On or WebForm_Captcha_Off or WebForm_Disable_Account_Updates or WebForm_Send_Confirmation_Email or WebForm_Send_Notification_Email or Login_Required or Disable_Support_Case_AutoReply or WebForm_CP_ShowAllUsers or WebForm_CP_ShowUserList or WebForm_CP_ShowUserTags or WebForm_CP_Internal</Flags> <ConfirmationConfig> <EmailFrom>string</EmailFrom> <EmailFromName>string</EmailFromName> <Subject>string</Subject> <Html>string</Html> </ConfirmationConfig> <ObjectCreationConfig> <Lead_Name>string</Lead_Name> <Lead_DefaultName>string</Lead_DefaultName> <Lead_Source>string</Lead_Source> <Lead_Owner>int</Lead_Owner> <Lead_SalesProcess>int</Lead_SalesProcess> <Lead_ProbabilityPercent>int</Lead_ProbabilityPercent> <Lead_Referrer>int</Lead_Referrer> <Lead_Description>string</Lead_Description> <SupportCase_Owner>int</SupportCase_Owner> <SupportCase_Name>string</SupportCase_Name> <SupportCase_DefaultName>string</SupportCase_DefaultName> <SupportCase_Status>int</SupportCase_Status> <SupportCase_Priority>int</SupportCase_Priority> <SupportCase_Type>int</SupportCase_Type> <SupportCase_Description>string</SupportCase_Description> <Contact_Tags d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <Contact_New_Option>int</Contact_New_Option> <Contact_New_TagApplyNewContacts>boolean</Contact_New_TagApplyNewContacts> <Contact_New_TagApplyExisting>boolean</Contact_New_TagApplyExisting> <CP_Client_Ids d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CP_Client_Tags d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CP_Client_TagIDs d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <SubmitButtonText>string</SubmitButtonText> <Campaign_Progress d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <Campaign_DateRefreshed>dateTime</Campaign_DateRefreshed> </ObjectCreationConfig> <Delete>boolean</Delete> <RemoveParentLinks>boolean</RemoveParentLinks> <SubmissionCount>int</SubmissionCount> </Template> <Template> <Type>Form or Email or Letter or Invoice</Type> <TemplateID>int</TemplateID> <Notifications> <Person d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <Person d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </Notifications> <Name>string</Name> <Description>string</Description> <ConfirmationInfo>string</ConfirmationInfo> <OriginalFileName>string</OriginalFileName> <DateModified>dateTime</DateModified> <Html>string</Html> <Plain>string</Plain> <Subject>string</Subject> <EmailFrom>string</EmailFrom> <EmailFromName>string</EmailFromName> <Fields> <Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <Field d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </Fields> <MailingLists> <MailingList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <MailingList d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> </MailingLists> <MailingStarted>boolean</MailingStarted> <Flags>None or Creates_Lead_Profile or Creates_Support_Case or Auto_Archive or Group_Timesheet_Activities or Group_Timesheet_Root_Projects or Group_Timesheet_Sub_Projects or Group_Timesheet_ByDay or Label_Top_Aligned or Label_Left_Aligned or WebForm_Confirmation_Show_Text or WebForm_Confirmation_Redirect or WebForm_Creates_Account or WebForm_Captcha_On or WebForm_Captcha_Off or WebForm_Disable_Account_Updates or WebForm_Send_Confirmation_Email or WebForm_Send_Notification_Email or Login_Required or Disable_Support_Case_AutoReply or WebForm_CP_ShowAllUsers or WebForm_CP_ShowUserList or WebForm_CP_ShowUserTags or WebForm_CP_Internal</Flags> <ConfirmationConfig> <EmailFrom>string</EmailFrom> <EmailFromName>string</EmailFromName> <Subject>string</Subject> <Html>string</Html> </ConfirmationConfig> <ObjectCreationConfig> <Lead_Name>string</Lead_Name> <Lead_DefaultName>string</Lead_DefaultName> <Lead_Source>string</Lead_Source> <Lead_Owner>int</Lead_Owner> <Lead_SalesProcess>int</Lead_SalesProcess> <Lead_ProbabilityPercent>int</Lead_ProbabilityPercent> <Lead_Referrer>int</Lead_Referrer> <Lead_Description>string</Lead_Description> <SupportCase_Owner>int</SupportCase_Owner> <SupportCase_Name>string</SupportCase_Name> <SupportCase_DefaultName>string</SupportCase_DefaultName> <SupportCase_Status>int</SupportCase_Status> <SupportCase_Priority>int</SupportCase_Priority> <SupportCase_Type>int</SupportCase_Type> <SupportCase_Description>string</SupportCase_Description> <Contact_Tags d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <Contact_New_Option>int</Contact_New_Option> <Contact_New_TagApplyNewContacts>boolean</Contact_New_TagApplyNewContacts> <Contact_New_TagApplyExisting>boolean</Contact_New_TagApplyExisting> <CP_Client_Ids d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CP_Client_Tags d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <CP_Client_TagIDs d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <SubmitButtonText>string</SubmitButtonText> <Campaign_Progress d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" /> <Campaign_DateRefreshed>dateTime</Campaign_DateRefreshed> </ObjectCreationConfig> <Delete>boolean</Delete> <RemoveParentLinks>boolean</RemoveParentLinks> <SubmissionCount>int</SubmissionCount> </Template> </Forms> <EntityFlags>Sales_Lead or Customer or Supplier or Subscriber or Company or Person or Employee or Do_Not_Email or Inactive or Enable_Entry_Alerts or Disable_Login or Email_Bounced or Xero_Contact or Workgroup or Disable_Owner_Alerts or QuickBooks_Contact or Has_Avatar or PermissionInheritCompany or BirthDateYearOnly</EntityFlags> <RemoveParentLinks>boolean</RemoveParentLinks> <TagsToBeRemovedWhenUnsubscribeString>string</TagsToBeRemovedWhenUnsubscribeString> <TagsToBeRemovedWhenUnsubscribe> <string>string</string> <string>string</string> </TagsToBeRemovedWhenUnsubscribe> <Delete>boolean</Delete> <SubscribersCount>int</SubscribersCount> <Flags>None or SendToCompanyPrimaryContactIfNoEmail or SubscriberContainAllTags or RemoveFromListWhenTagRemoved or RemoveTagWhenUnsubscribe</Flags> </MailingList>