SendList Service

Owned by Melih Ayhan (Unlicensed)
Last updated: Oct 14, 2022 by Berk Topaloğlu
2 min read

On this page: 

AddBulkFile

URL

LIVE: https://api.relateddigital.com/resta/api/SendList/SendListAddBulkFile

ECOMM: https://api.relateddigital.com/reste/api/SendList/SendListAddBulkFile

LIVEB: https://api.relateddigital.com/liveb_rest/api/SendList/SendListAddBulkFile

LIVEM:https://api.relateddigital.com/restm/api/SendList/SendListAddBulkFile

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login.

Body

ListGroup (string): Group name of the List to add
ListName (string): Name of the List
Key(string): Reference Key Name. Member adding and updating shall be done based on this field
Map(string): Maps the fields in the file with the system fields. E.g. EMAIL=email; COLUMN1=NameSurname; COLUMN2=KeyID
File(string): The file to upload
FileType (string): File Type - must be in zip or csv format
NotificationEmail (string): A notification email will sent to this email address when the upload is completed


Sample Body

{
"ListGroup": "TestGrup1405201",

"ListName": "Liste14052018",

"Key": "KEY_ID",

"Map": "COLUMN30=KEY_ID;EMAIL=EMAIL",

"File": "S0VZX0lEfEVNQUlMCjg5Nzk4NDU0fGFsaS50ZWtAZXVyb21zZy5jb20=",

"FileType": "TXT",

"NotificationEmail": "notification_e-mail@euromsg.com",

"JobName": "Deneme"

}

The value of the file parameter must be the base64 encoded.

Sample Response

{
"ConversationID": null,

"CreatedListID": 0,

"Success": true,

"Errors": [],

"DetailedMessage": "",

"TransactionId": null
}


Successs Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,08,26,40,75,87,88,96,99,103,105,133,134, 550

ChangeSendListName

URL

LIVE: https://api.relateddigital.com/resta/api/SendList/ChangeSendListName

ECOMM: https://api.relateddigital.com/reste/api/SendList/ChangeSendListName

LIVEB: https://api.relateddigital.com/liveb_rest/api/SendList/ChangeSendListName

LIVEM: https://api.relateddigital.com/restm/api/SendList/ChangeSendListName

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

Body

ServiceTicket: ServiceTicket obtained throuh Login
ListGroup(string):Group name of the list.
ListName (string): Name of the List
NewListName(string): New name of the list.

Sample Body

{ 
"ListGroup": "Grup_new_2018",

"ListName": "Liste_new_Guncel",

"NewListName": "Liste_new_EnGuncel"

}

Sample Response

{
"Success": true,

"Errors": [],

"DetailedMessage": "",

"TransactionId": "DB7BA1D4376346AEA99AA3020DD074A2"

}

Success Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01

CreateSendList

URL

LIVE: https://api.relateddigital.com/resta/api/SendList/CreateSendList

ECOMM: https://api.relateddigital.com/reste/api/SendList/CreateSendList

LIVEB: https://api.relateddigital.com/liveb_rest/api/SendList/CreateSendList

LIVEM: https://api.relateddigital.com/restm/api/SendList/CreateSendList

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login.

Body

ListGroup (string): Group name of the List to add

ListName (string): Name of the List

Sample Body

{

  "ListGroup": "sample string 1",

  "ListName": "sample string 2"

}

Sample Response

{
  "ConversationID": null,

    "CreatedListID": 0,

    "Success": true,

    "Errors": [],

    "DetailedMessage": "",

    "TransactionId": "E37662F65C7A430EB5C05BC41BFBF7F1"
}

Succcess Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,08,26,40,75,87,88,96,99,103,105,133,134, 550

QuerySendListMemberCount 

URL

LIVE: https://api.relateddigital.com/resta/api/SendList/QuerySendListMemberCount

ECOMM: https://api.relateddigital.com/reste/api/SendList/QuerySendListMemberCount

LIVEB: https://api.relateddigital.com/liveb_rest/api/SendList/QuerySendListMemberCount

LIVEM: https://api.relateddigital.com/restm/api/SendList/QuerySendListMemberCount

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login.

Body


Sample Body

{

  "ListId": 1

}

Sample Response

{
    "ConversationID": null,

    "CreatedListID": 0,

    "Success": true,

    "Errors": [],

    "DetailedMessage": "",

    "TransactionId": "E37662F65C7A430EB5C05BC41BFBF7F1"
}

Succcess Response

Status Code: 200

http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,08,26,40,75,87,88,96,99,103,105,133,134, 550

QuerySendLists 

URL

LIVE: https://api.relateddigital.com/resta/api/SendList/QuerySendLists

ECOMM: https://api.relateddigital.com/reste/api/SendList/QuerySendLists

LIVEB: https://api.relateddigital.com/liveb_rest/api/SendList/QuerySendLists

LIVEM: https://api.relateddigital.com/restm/api/SendList/QuerySendLists

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login.

Body


Sample Body

No parameter

Sample Response


Succcess Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,08,26,40,75,87,88,96,99,103,105,133,134, 550


RemoveBulkFile 

URL

LIVE: https://api.relateddigital.com/resta/api/SendList/RemoveBulkFile

ECOMM: https://api.relateddigital.com/reste/api/SendList/RemoveBulkFile

LIVEB: https://api.relateddigital.com/liveb_rest/api/SendList/RemoveBulkFile

LIVEM: https://api.relateddigital.com/restm/api/SendList/RemoveBulkFile

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login.

Body

ListGroup (string): Group name of the List to add

ListName (string): Name of the List

Key(string): Reference Key Name. Member adding and updating shall be done based on this field

Map(string): Maps the fields in the file with the system fields. E.g. EMAIL=email; COLUMN1=NameSurname; COLUMN2=KeyID

File(string): The file to upload

FileType (string): File Type - must be in zip or csv format

NotificationEmail (string): A notification email will sent to this email address when the upload is completed

Sample Body

{

  "ListGroup": "sample string 1",

  "ListName": "sample string 2",

  "Key": "sample string 3",

  "Map": "sample string 4",

  "File": "QEA=",

  "FileType": "sample string 5",

  "NotificationEmail": "sample string 6",

  "DeleteIfInNoList": true

}

Sample Response


Succcess Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,08,26,40,75,87,88,96,99,103,105,133,134, 550


RemoveSendList

URL

LIVE: https://api.relateddigital.com/resta/api/SendList/RemoveSendList

ECOMM: https://api.relateddigital.com/reste/api/SendList/RemoveSendList

LIVEB: https://api.relateddigital.com/liveb_rest/api/SendList/RemoveSendList

LIVEM: https://api.relateddigital.com/restm/api/SendList/RemoveSendList

Http verb

POST

Parameters


Header

Content-Type: application/json

Authorization: The ticket given by the system after successfull login

Body

ListGroup (string): Group name of the List to add

ListName (string): Name of the List

Sample Body

{

  "ListGroup": "sample string 1",

  "ListName": "sample string 2"

}

Sample Response

{
    "ConversationID": null,

    "CreatedListID": 0,

    "Success": true,

    "Errors": [],

    "DetailedMessage": "",

    "TransactionId": "E37662F65C7A430EB5C05BC41BFBF7F1"
}

Succcess Response

Status Code: 200

Http Error Response

Status Code: 400 Bad Request

Status Code: 401 Unauthorized

Error Code

00, 01,08,26,40,75,87,88,96,99,103,105,133,134, 550


Parent Topic: RMC REST API

Copyright 2020 Related Digital