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 SenList Web Service and provides a brief description of each method. For more detail on each method, click the method name.
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 |
---|
| . |
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"?>
<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>
<CreateSendList xmlns="http://ws.euromsg.com/sendlist">
<ServiceTicket>string</ServiceTicket>
<ListGroup>string</ListGroup>
<ListName>string</ListName>
</CreateSendList>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<CreateSendListResponse xmlns="http://ws.euromsg.com/sendlist">
<CreateSendListResult>
<Code>00</Code>
<Message />
<DetailedMessage />
<CreatedListID>1686794</CreatedListID>
</CreateSendListResult>
</CreateSendListResponse>
</soap:Body>
</soap: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
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"?>
<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>
<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>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<AddBulkResponse
xmlns="http://ws.euromsg.com/sendlist">
<AddBulkResult>
<Code>00</Code>
<Message />
<DetailedMessage />
<CreatedListID>0</CreatedListID>
</AddBulkResult>
<DetailsResult>
<BulkDetailedResult>
<Key>test1@sampledomain.com</Key>
<Code>00</Code>
<Message />
<DetailedMessage />
</BulkDetailedResult>
<BulkDetailedResult>
<Key>test2@sampledomain.com</Key>
<Code>00</Code>
<Message />
<DetailedMessage />
</BulkDetailedResult>
</DetailsResult>
</AddBulkResponse>
</soap:Body>
</soap: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
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"?>
<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>
<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>
</AddBulkFile>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<AddBulkFileResponse
xmlns="http://ws.euromsg.com/sendlist">
<AddBulkFileResult>
<Code>00</Code>
<Message />
<DetailedMessage />
<ConversationID>EEFF123AE537442BBF9AD3231F812684</ConversationID>
<CreatedListID>0</CreatedListID>
</AddBulkFileResult>
</AddBulkFileResponse>
</soap:Body>
</soap: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"?>
<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>
<QuerySendListMemberCount
xmlns="http://ws.euromsg.com/sendlist">
<ServiceTicket>string</ServiceTicket>
<ListID>int</ListID>
</QuerySendListMemberCount>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<QuerySendListMemberCountResponse xmlns="http://ws.euromsg.com/sendlist">
<QuerySendListMemberCountResult>
<Code>00</Code>
<Message />
<DetailedMessage />
<CreatedListID>0</CreatedListID>
</QuerySendListMemberCountResult>
<MemberCount>0</MemberCount>
</QuerySendListMemberCountResponse>
</soap:Body>
</soap: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"?>
<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>
<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>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<RemoveBulkFileResponse xmlns="http://ws.euromsg.com/sendlist">
<RemoveBulkFileResult>
<Code>00</Code>
<Message />
<DetailedMessage />
<ConversationID>EEFF123AE537442BBF9AD3231F812684</ConversationID>
<CreatedListID>0</CreatedListID>
</RemoveBulkFileResult>
</RemoveBulkFileResponse >
</soap:Body>
</soap: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 | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<RemoveSendList xmlns="http://ws.euromsg.com/sendlist">
<ServiceTicket>string</ServiceTicket>
<ListGroup>string</ListGroup>
<ListName>string</ListName>
</RemoveSendList>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<RemoveSendListResponse
xmlns="http://ws.euromsg.com/sendlist">
<RemoveSendListResult>
<Code>00</Code>
<Message />
<DetailedMessage />
<CreatedListID>0</CreatedListID>
</RemoveSendListResult>
</RemoveSendListResponse>
</soap:Body>
</soap: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
Back to Top ^
<QuerySendList> |
---|
Query Send Lists of customer. |
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"?>
<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>
<QuerySendLists xmlns="http://ws.euromsg.com/sendlist">
<ServiceTicket>string</ServiceTicket>
</QuerySendLists>
</soap:Body>
</soap:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?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>
<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>
</soap:Body>
</soap: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