SendList Web Service

Owned by Ogün Öztürk (Unlicensed)
Last updated: Nov 01, 2022 by Berk Topaloğlu
8 min read

POST 

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.

ChangeSendListNameChanges 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.

QuerySendListsQueries Send Lists.

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.

To interact with any Web Services, developers must first use the Login method to create a SERVICE TICKET. Developers can send requests to other Web Service and methods using this SERVICE TICKET.


ChangeSendListName

Back to Top ^

<Change Send List Name>
Changes list name.

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

ListGroupGroup Name of the List

MANDATORY

ListNameName of the list

MANDATORY

NewListNameNew name of the list

MANDATORY

REQUEST EXAMPLE
<?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>
RESPONSE EXAMPLE
<?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>

If the request was successful, the CODE parameter will return 00 as a response.

Error Parameters

CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.

CreateSendList 

Back to Top ^

<CreateSendList>
Creates an empty Send List.

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

ListGroupGroup Name of the List

MANDATORY

ListNameName of the list

MANDATORY

REQUEST EXAMPLE
<?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>
RESPONSE EXAMPLE
<?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>

If the request was successful, the CODE parameter will return 00 as a response. In addition to that, the ID of the created list CREATEDLISTID is returned.

Error Parameters

CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.


AddBulk 

Back to Top ^

<AddBulk>
Bulk adds to a Send List.

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

ListGroup

Group name of the List to add

MANDATORY

ListNameName of the List

MANDATORY

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

MANDATORY

DemograficDataArrayOfEmKeyValue string defines the fields for the member

MANDATORY

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

MANDATORY

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

Static Fields

Field NameDescription
EMAILEmail address
STATUSMember Status. A: Active, P: Passive
EMAIL_PERMITEmail opt-in. Y: Yes, N: No
GSM_PERMITSMS opt-in. Y: Yes, N: No
FAX_PERMITFAX opt-in. Y: Yes, N: No
CALL_PERMITCall Center opt-in. Y: Yes, N: No
PRINT_PERMITPrint opt-in. Y: Yes, N: No
REFERRALReferral Address
REFERRAL_DOMAINReferral Domain
REQUEST EXAMPLE
<?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>
RESPONSE EXAMPLE
<?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>

If the request was successful, the CODE parameter will return 00 as a response.

Error Parameters

CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.
99No such list!The specified List cannot be found.
99Member 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 

Back to Top ^

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

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

ListGroupGroup name of the List to add

MANDATORY

ListNameName of the List

MANDATORY

Key

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

MANDATORY

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

MANDATORY

File

The file to upload

MANDATORY

FileType

File Type - Must be in zip or csv format

MANDATORY

NotificationEmail

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

MANDATORY

REQUEST EXAMPLE
<?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>
RESPONSE EXAMPLE
<?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>

If the request was successful, the CODE parameter will return 00 as a response. In addition to that, the ID of the created list CREATEDLISTID is returned.

Error Parameters

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


QuerySendListMemberCount 

Back to Top ^

<QuerySendListMemberCount>

Shows the number of members in the send list.

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

ListIDList ID

MANDATORY


REQUEST EXAMPLE
<?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>
RESPONSE EXAMPLE
<?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>

If the request was successful, the CODE parameter will return 00 as a response.

Error Parameters

CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.


RemoveBulkFile 

Back to Top ^

<RemoveBulkFile>

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

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

ListGroupGroup name of the List

MANDATORY

ListNameName of the list

MANDATORY

KeyReference Key Name

MANDATORY

Map

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

MANDATORY

FileFile to upload

MANDATORY

FileTypeFile Type - Must be in zip or csv format

MANDATORY

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

MANDATORY

DeleteIfInNoList

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

MANDATORY

REQUEST EXAMPLE
<?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>
RESPONSE EXAMPLE
<?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>

If the request was successful, the CODE parameter will return 00 as a response. In addition to that, the ID of the created list CREATEDLISTID is returned.

Error Parameters

CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.


RemoveSendList 

Back to Top ^

<RemoveSendList>
Deletes a Send List.

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY

ListGroupGroup Name of the List

MANDATORY

ListNameName of the List


REQUEST EXAMPLE
<?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>
RESPONSE EXAMPLE
<?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>

If the request was successful, the CODE parameter will return 00 as a response. Aside from that, the returned 99 values indicates errors.

Error Parameters

CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.


QuerySendList 

Back to Top ^

<QuerySendList>

Query Send Lists.

Parameters

ParameterValue
ServiceTicketServiceTicket obtained through Login

MANDATORY


REQUEST EXAMPLE
<?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>
RESPONSE EXAMPLE
<?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>

If the request was successful, the CODE parameter will return 00 as a response.

Error Parameters

CodeError MessageDescription
9998No session. Please try re-logon.No active sessions found. Try login again.


Parent Topic: SOAP Web Service


Copyright 2020 Related Digital