On this Page:
Table of Contents
...
Note: You can either use HTTPS for your requests.
...
InsertMemberDemography
URL | LIVE: https://api.relateddigital.com/resta/api/Member/InsertMemberDemography ECOMM: https://api.relateddigital.com/reste/api/Member/InsertMemberDemography LIVEB: https://api.relateddigital.com/rest_liveb/api/Member/InsertMemberDemography | |||||
|---|---|---|---|---|---|---|
Http verb | POST | |||||
Parameters | ||||||
Header | Content-Type: application/json Authorization: The ticket issued by the system after successful login | |||||
Body | Key(string): This can be EMAIL, MEMBER_ID or any column the developer wants like Name, Surname as configured by using the RMC admin panel. Value(string): This is the value of the Key Column. If this value sent in the wrong format, it will be ignored and the main process will not be interrupted. ForceUpdate(bool): If this flag is true, it updates the member by using the demographic information provided. Otherwise, give Code not equal 00 back and put already existing member in Message property of MemberResult object. DemographicData(KeyValue []): This is an KeyValue array. In short, keys and values that composes the demographic information.
| |||||
Sample Body | { "Key" : "", "Value" : "", "ForceUpdate" : false, "DemographicData" : [ { "Key" : "", "Value": ""}, { "Key" : "", "Value": ""} ] } | |||||
Sample Response | { "MemberId": "" "Success": false, "Errors": [ { "Code": "", "Message": "" } ], "DetailedMessage": "" "TransactionId": "" } | |||||
Success Response | Status Code: 200 | |||||
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized | |||||
Error Code | 00, 01, 06, 25, 43, 69, 99, 107 |
UpdateMemberDemography
URL | LIVE: https://api.relateddigital.com/resta/api/Member/UpdateMemberDemography ECOMM: https://api.relateddigital.com/reste/api/Member/UpdateMemberDemography LIVEB: https://api.relateddigital.com/rest_liveb/api/Member/UpdateMemberDemography |
|---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket issued by the system after successful login |
Body | Key(string): This can be EMAIL, MEMBER_ID or any column the developer wants to use like Name, Surname as configured by using the RMC admin panel. Value(string): This is the value of the Key Column. If this value is sent in the wrong format, it will be ignored and the main process will not be interrupted. ForceInsert(bool): If this flag is true, it inserts the member by using the demographic information provided. Otherwise, give Code not equal 00 back and put Not existing member in Message property of MemberResult object DemographicData(KeyValue []): This is a KeyValue array. In short, keys and values that composes the demographic information. |
Sample Body | { "Key" : "", "Value" : "", "ForceInsert" : true, "DemographicData" : [ { "Key" : "", "Value": ""}, { "Key" : "", "Value": ""} ] } |
Sample Response | { "MemberId": "" "Success": false, "Errors": [ { "Code": "", "Message": "" } ], "DetailedMessage": "" "TransactionId": "" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized |
Error Code | 00, 01, 06, 43, 66, 69, 99, 107 |
AddToSendLists
URL | LIVE: https://api.relateddigital.com/resta/api/Member/AddToSendLists ECOMM: https://api.relateddigital.com/reste/api/Member/AddToSendLists LIVEB: https://api.relateddigital.com/rest_liveb/api/Member/AddToSendLists |
|---|---|
Http verb | POST |
Parameters | |
Header | Content-Type: application/json Authorization: The ticket issued by the system after successful login |
Body | Key(string): This can be EMAIL, MEMBER_ID or any column the developer wants to use like Name, Surname as configured by using the RMC admin panel. Value(string): This is the value of the Key Column. If this value is sent in the wrong format, it will be ignored and the main process will not be interrupted. Move(bool): If Move is given True, the member will be removed from the old lists which are not specified in SendLists array. If Move is given False, the member will only be added to the specified lists. SendLists(SendList []): The member specified by Key and Value pair will be added to these lists. |
Sample Body | { "Key" : "", "Value" : "", "Move" : false, "SendLists" : [ { "ListName" : "", "GroupName": ""}, { "ListName" : "", "GroupName": ""} ] } |
Sample Response | { "MemberId": "" "Success": false, "Errors": [ { "Code": "", "Message": "" } ], "DetailedMessage": "" "TransactionId": "" } |
Success Response | Status Code: 200 |
Http Error Response | Status Code: 400 Bad Request Status Code: 401 Unauthorized Status Code: 404 Not Found |
Error Code | 00, 01, 43, 66, 69, 99, 107 |
...