Page Comparison

Status

colour	Green
title	post

Anchor

	topslws
	topslws

Service URL

LIVE: https://api.relateddigital.com/live/sendlist.asmx

ECOMM: https://api.relateddigital.com/ecomm/sendlist.asmx

MAX: https://api.relateddigital.com/max/sendlist.asmx

LIVEB: https://api.relateddigital.com/liveb/sendlist.asmx

General Information

SendList Web Service allows you to perform many operations:

Add data in bulk to your Send Lists
Create Send Lists
Remove existing Send Lists from your account

SendList Web Service Methods

The following table lists supported methods in SendList Web Service and provides a brief description of each method. Click on the method name for more information:

Method	Description
AddBulk	Bulk adds to a Send List.
AddBulkFile	Bulk adds to a Send List via File Upload.
CreateSendList	Creates an empty Send List.
ChangeSendListName	Changes list name.
QuerySendListMemberCount	Returns the number of members found in a given Send List.
RemoveBulkFile	Bulk removes from a Send List or deletes members via File Upload.
RemoveSendList	Removes a Send List.
QuerySendLists	Queries Send Lists.

Note
We advise you to be careful when deleting a member from your account. As per the Law that came into force in May 2015, you must save member history information for minimum one year.

Warning

To interact with any Web Services, developers must first use the Login method to create a

Status


subtle	true
colour	Red
title	Service Ticket

. Developers can send requests to other Web Service and methods using this

Status


subtle	true
colour	Red
title	Service Ticket

.

ChangeSendListName
Anchor
ChangeSendListName
ChangeSendListName

Back to Top ^

<Change Send List Name>
Changes list name.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

ListGroup

Group Name of the List

Status

colour	Green
title	mandatory

ListName

Name of the list

Status

colour	Green
title	mandatory

NewListName

New name of the list

Status

colour	Green
title	mandatory

Code Block

language	xml
title	REQUEST EXAMPLE
linenumbers	true

<?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>
    <ChangeSendListName xmlns="http://ws.euromsg.com/sendlist">
      <ServiceTicket>string</ServiceTicket>
      <ListGroup>string</ListGroup>
      <ListName>string</ListName>
      <NewListName>string</NewListName>
    </ChangeSendListName>
  </soap12:Body>
</soap12:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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>
    <ChangeSendListNameResponse xmlns="http://ws.euromsg.com/sendlist">
      <ChangeSendListNameResult>
        <ConversationID>string</ConversationID>
        <CreatedListID>int</CreatedListID>
      </ChangeSendListNameResult>
    </ChangeSendListNameResponse>
  </soap12:Body>
</soap12:Envelope>

Tip

If the request was successful, the

Status

subtle	true
colour	Red
title	Code

parameter will return

Status


subtle	true
colour	Red
title	00

as a response.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.

CreateSendList
Anchor
createsendlist
createsendlist

Back to Top ^

<CreateSendList>
Creates an empty Send List.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

ListGroup

Group Name of the List

Status

colour	Green
title	mandatory

ListName

Name of the list

Status

colour	Green
title	mandatory

Code Block

language	xml
title	REQUEST EXAMPLE
linenumbers	true

<?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>
    <CreateSendList xmlns="http://ws.euromsg.com/sendlist">
      <ServiceTicket>string</ServiceTicket>
      <ListGroup>string</ListGroup>
      <ListName>string</ListName>
    </CreateSendList>
  </soap12:Body>
</soap12:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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>
    <CreateSendListResponse xmlns="http://ws.euromsg.com/sendlist">
      <CreateSendListResult>
        <ConversationID>string</ConversationID>
        <CreatedListID>int</CreatedListID>
      </CreateSendListResult>
    </CreateSendListResponse>
  </soap12:Body>
</soap12:Envelope>

Tip

If the request was successful, the

Status

subtle	true
colour	Red
title	Code

parameter will return

Status


subtle	true
colour	Red
title	00

as a response. In addition to that, the ID of the created list

Status


subtle	true
colour	Red
title	CreatedListID

is returned.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.

AddBulk
Anchor
addbulk
addbulk

Back to Top ^

<AddBulk>
Bulk adds to a Send List.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

ListGroup

Group name of the List to add

Status

colour	Green
title	mandatory

ListName

Name of the List

Status

colour	Green
title	mandatory

Key

Reference Key Name. Member adding and updating will be done based on this field. Reference Key value must be specified in the DemograficData field

Status

colour	Green
title	mandatory

DemograficData

ArrayOfEmKeyValue string defines the fields for the member

Status

colour	Green
title	mandatory

ForceInsert

If the member exists in the system and the value is true , the existing member is updated.

Status

colour	Green
title	mandatory

Note
Fields like First Name and Last Name are set through the Related Marketing Cloud platform.

Static Fields

Field Name	Description
EMAIL	Email address
STATUS	Member Status. A: Active, P: Passive
EMAIL_PERMIT	Email opt-in. Y: Yes, N: No
GSM_PERMIT	SMS opt-in. Y: Yes, N: No
FAX_PERMIT	FAX opt-in. Y: Yes, N: No
CALL_PERMIT	Call Center opt-in. Y: Yes, N: No
PRINT_PERMIT	Print opt-in. Y: Yes, N: No
REFERRAL	Referral Address
REFERRAL_DOMAIN	Referral Domain

Code Block

language	xml
title	REQUEST EXAMPLE
linenumbers	true

<?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>
    <AddBulk xmlns="http://ws.euromsg.com/sendlist">
      <ServiceTicket>string</ServiceTicket>
      <ListGroup>string</ListGroup>
      <ListName>string</ListName>
      <Key>string</Key>
      <DemograficData>
        <ArrayOfEmKeyValue>
          <EmKeyValue>
            <Key>string</Key>
            <Value>string</Value>
          </EmKeyValue>
          <EmKeyValue>
            <Key>string</Key>
            <Value>string</Value>
          </EmKeyValue>
        </ArrayOfEmKeyValue>
        <ArrayOfEmKeyValue>
          <EmKeyValue>
            <Key>string</Key>
            <Value>string</Value>
          </EmKeyValue>
          <EmKeyValue>
            <Key>string</Key>
            <Value>string</Value>
          </EmKeyValue>
        </ArrayOfEmKeyValue>
      </DemograficData>
      <ForceInsert>boolean</ForceInsert>
    </AddBulk>
  </soap12:Body>
</soap12:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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>
    <AddBulkResponse xmlns="http://ws.euromsg.com/sendlist">
      <AddBulkResult>
        <ConversationID>string</ConversationID>
        <CreatedListID>int</CreatedListID>
      </AddBulkResult>
      <DetailsResult>
        <BulkDetailedResult>
          <Key>string</Key>
          <Code>string</Code>
          <Message>string</Message>
          <DetailedMessage>string</DetailedMessage>
        </BulkDetailedResult>
        <BulkDetailedResult>
          <Key>string</Key>
          <Code>string</Code>
          <Message>string</Message>
          <DetailedMessage>string</DetailedMessage>
        </BulkDetailedResult>
      </DetailsResult>
    </AddBulkResponse>
  </soap12:Body>
</soap12:Envelope>

Tip

If the request was successful, the

Status


subtle	true
colour	Red
title	Code

parameter will return

Status


subtle	true
colour	Red
title	00

as a response.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	No such list!	The specified List cannot be found.
99	Member is new. No update!	If ForceInsert is false and the user does not exist in the system, this error is given. The member is not added. To add the new member in the system the value of the ForceInsertparameter must be true.

AddBulkFile
Anchor
addbulkfile
addbulkfile

Back to Top ^

<AddBulkFile>
Allows you to add all the members listed in a file to your RMC account in bulk.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

ListGroup

Group name of the List to add

Status

colour	Green
title	mandatory

ListName

Name of the List

Status

colour	Green
title	mandatory

Key

Reference Key Name. Member adding and updating shall be done based on this field

Status

colour	Green
title	mandatory

Map

Maps the fields in the file with the system fields. E.g. EMAIL=email; COLUMN1=NameSurname; COLUMN2=KeyID

Status

colour	Green
title	mandatory

File

The file to upload

Status

colour	Green
title	mandatory

FileType

File Type - Must be in zip or csv format

Status

colour	Green
title	mandatory

NotificationEmail

A notification email will sent to this email address when the upload is completed

Status

colour	Green
title	mandatory

Code Block

language	xml
title	REQUEST EXAMPLE
linenumbers	true

<?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>
    <AddBulkFile xmlns="http://ws.euromsg.com/sendlist">
      <ServiceTicket>string</ServiceTicket>
      <ListGroup>string</ListGroup>
      <ListName>string</ListName>
      <Key>string</Key>
      <Map>string</Map>
      <File>base64Binary</File>
      <FileType>string</FileType>
      <NotificationEmail>string</NotificationEmail>
      <JobName>string</JobName>
    </AddBulkFile>
  </soap12:Body>
</soap12:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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>
    <AddBulkFileResponse xmlns="http://ws.euromsg.com/sendlist">
      <AddBulkFileResult>
        <ConversationID>string</ConversationID>
        <CreatedListID>int</CreatedListID>
      </AddBulkFileResult>
    </AddBulkFileResponse>
  </soap12:Body>
</soap12:Envelope>

Tip

If the request was successful, the

Status

subtle	true
colour	Red
title	Code

parameter will return

Status


subtle	true
colour	Red
title	00

as a response. In addition to that, the ID of the created list

Status


subtle	true
colour	Red
title	CreatedListID

is returned.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.
99	Not a valid file type. It must be ZIP or CSV or TXT.	Invalid file type. It must be in `zip` or `csv` format

QuerySendListMemberCount
Anchor
querymemcount
querymemcount

Back to Top ^

<QuerySendListMemberCount>
Shows the number of members in the send list.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

ListID

List ID

Status

colour	Green
title	mandatory

Code Block

language	xml
title	REQUEST EXAMPLE
linenumbers	true

<?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>
    <QuerySendListMemberCount xmlns="http://ws.euromsg.com/sendlist">
      <ServiceTicket>string</ServiceTicket>
      <ListID>int</ListID>
    </QuerySendListMemberCount>
  </soap12:Body>
</soap12:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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>
    <QuerySendListMemberCountResponse xmlns="http://ws.euromsg.com/sendlist">
      <QuerySendListMemberCountResult>
        <ConversationID>string</ConversationID>
        <CreatedListID>int</CreatedListID>
      </QuerySendListMemberCountResult>
      <MemberCount>int</MemberCount>
    </QuerySendListMemberCountResponse>
  </soap12:Body>
</soap12:Envelope>

Tip

If the request was successful, the

Status


subtle	true
colour	Red
title	Code

parameter will return

Status


subtle	true
colour	Red
title	00

as a response.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.

RemoveBulkFile
Anchor
removebulkfile
removebulkfile

Back to Top ^

<RemoveBulkFile>
Allows you to delete the members listed in a file in your RMC account.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

ListGroup

Group name of the List

Status

colour	Green
title	mandatory

ListName

Name of the list

Status

colour	Green
title	mandatory

Key

Reference Key Name

Status

colour	Green
title	mandatory

Map

Maps the fields in the file with the system fields. E.g. EMAIL=email; COLUMN1=NameSurname ;COLUMN2=KeyID

Status

colour	Green
title	mandatory

File

File to upload

Status

colour	Green
title	mandatory

FileType

File Type - Must be in zip or csv format

Status

colour	Green
title	mandatory

NotificationEmail

A notification email will sent to this email address when the upload is completed

Status

colour	Green
title	mandatory

DeleteIfInNoList

If the member is not included in any lists, and the value is true, the user is deleted from the system completely

Status

colour	Green
title	mandatory

Code Block

language	xml
title	REQUEST EXAMPLE
linenumbers	true

<?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>
    <RemoveBulkFile xmlns="http://ws.euromsg.com/sendlist">
      <ServiceTicket>string</ServiceTicket>
      <ListGroup>string</ListGroup>
      <ListName>string</ListName>
      <Key>string</Key>
      <Map>string</Map>
      <File>base64Binary</File>
      <FileType>string</FileType>
      <NotificationEmail>string</NotificationEmail>
      <DeleteIfInNoList>boolean</DeleteIfInNoList>
    </RemoveBulkFile>
  </soap12:Body>
</soap12:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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>
    <RemoveBulkFileResponse xmlns="http://ws.euromsg.com/sendlist">
      <RemoveBulkFileResult>
        <ConversationID>string</ConversationID>
        <CreatedListID>int</CreatedListID>
      </RemoveBulkFileResult>
    </RemoveBulkFileResponse>
  </soap12:Body>
</soap12:Envelope>

Tip

If the request was successful, the

Status

subtle	true
colour	Red
title	Code

parameter will return

Status


subtle	true
colour	Red
title	00

as a response. In addition to that, the ID of the created list

Status


subtle	true
colour	Red
title	CreatedListID

is returned.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.

RemoveSendList
Anchor
removesendlist
removesendlist

Back to Top ^

<RemoveSendList>
Deletes a Send List.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

ListGroup

Group Name of the List

Status

colour	Green
title	mandatory

ListName

Name of the List

Code Block

language	xml
title	REQUEST EXAMPLE
linenumbers	true

<?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>
    <RemoveSendList xmlns="http://ws.euromsg.com/sendlist">
      <ServiceTicket>string</ServiceTicket>
      <ListGroup>string</ListGroup>
      <ListName>string</ListName>
    </RemoveSendList>
  </soap12:Body>
</soap12:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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>
    <RemoveSendListResponse xmlns="http://ws.euromsg.com/sendlist">
      <RemoveSendListResult>
        <ConversationID>string</ConversationID>
        <CreatedListID>int</CreatedListID>
      </RemoveSendListResult>
    </RemoveSendListResponse>
  </soap12:Body>
</soap12:Envelope>

Tip

If the request was successful, the

Status


subtle	true
colour	Red
title	Code

parameter will return

Status


subtle	true
colour	Red
title	00

as a response. Aside from that, the returned

Status


subtle	true
colour	Red
title	99

values indicates errors.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.

QuerySendList
Anchor
querysend
querysend

Back to Top ^

<QuerySendList>
Query Send Lists.

Parameters

Parameter Value

ServiceTicket

ServiceTicket obtained through Login

Status

colour	Green
title	mandatory

Code Block

language	xml
title	REQUEST EXAMPLE
linenumbers	true

<?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>
    <QuerySendLists xmlns="http://ws.euromsg.com/sendlist">
      <ServiceTicket>string</ServiceTicket>
    </QuerySendLists>
  </soap12:Body>
</soap12:Envelope>

Code Block

language	xml
title	RESPONSE EXAMPLE
linenumbers	true

<?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>
    <QuerySendListsResponse xmlns="http://ws.euromsg.com/sendlist">
      <QuerySendListsResult>
        <SendLists>
          <EmSendListResponse>
            <ListId>string</ListId>
            <ListName>string</ListName>
            <GroupName>string</GroupName>
          </EmSendListResponse>
          <EmSendListResponse>
            <ListId>string</ListId>
            <ListName>string</ListName>
            <GroupName>string</GroupName>
          </EmSendListResponse>
        </SendLists>
      </QuerySendListsResult>
    </QuerySendListsResponse>
  </soap12:Body>
</soap12:Envelope>

Tip

If the request was successful, the

Status


subtle	true
colour	Red
title	Code

parameter will return

Status


subtle	true
colour	Red
title	00

as a response.

Error Parameters

Code	Error Message	Description
9998	No session. Please try re-logon.	No active sessions found. Try login again.

Parent Topic: SOAP Web Service

Versions Compared

Old Version 47

New Version Current

Key

General Information

SendList Web Service Methods

ChangeSendListName
Anchor
ChangeSendListName
ChangeSendListName

Parameters

Error Parameters

CreateSendList
Anchor
createsendlist
createsendlist

Parameters

Error Parameters

AddBulk
Anchor
addbulk
addbulk

Parameters

Static Fields

Error Parameters

AddBulkFile
Anchor
addbulkfile
addbulkfile

Parameters

Error Parameters

QuerySendListMemberCount
Anchor
querymemcount
querymemcount

Parameters

Error Parameters

RemoveBulkFile
Anchor
removebulkfile
removebulkfile

Parameters

Error Parameters

RemoveSendList
Anchor
removesendlist
removesendlist

Parameters

Error Parameters

QuerySendList
Anchor
querysend
querysend

Parameters

Error Parameters

Page Comparison

Versions Compared

Old Version 47

New Version Current

Key

General Information

SendList Web Service Methods

ChangeSendListName AnchorChangeSendListNameChangeSendListName

Parameters

Error Parameters

CreateSendList Anchorcreatesendlistcreatesendlist

Parameters

Error Parameters

AddBulk Anchoraddbulkaddbulk

Parameters

Static Fields

Error Parameters

AddBulkFile Anchoraddbulkfileaddbulkfile

Parameters

Error Parameters

QuerySendListMemberCount Anchorquerymemcountquerymemcount

Parameters

Error Parameters

RemoveBulkFile Anchorremovebulkfileremovebulkfile

Parameters

Error Parameters

RemoveSendList Anchorremovesendlistremovesendlist

Parameters

Error Parameters

QuerySendList Anchorquerysendquerysend

Parameters

Error Parameters

ChangeSendListName
Anchor
ChangeSendListName
ChangeSendListName

CreateSendList
Anchor
createsendlist
createsendlist

AddBulk
Anchor
addbulk
addbulk

AddBulkFile
Anchor
addbulkfile
addbulkfile

QuerySendListMemberCount
Anchor
querymemcount
querymemcount

RemoveBulkFile
Anchor
removebulkfile
removebulkfile

RemoveSendList
Anchor
removesendlist
removesendlist

QuerySendList
Anchor
querysend
querysend