Member Service
On this Page:
- 1 InsertMemberDemography
- 2
- 3 UpdateMemberDemography
- 4
- 5 AddToSendLists
- 6
- 7 QueryMemberId
- 8
- 9 QueryMemberDemography
- 10
- 11 QuerySendLists
- 12
- 13 RemoveFromSendLists
- 14
- 15 AddToAllLists
- 16
- 17 AddToWebLists
- 18
- 19 SendOngoingEmail
- 20
- 21 SendOngoingSms
- 22
- 23 ChangeMemberPermissionByEmail
- 24 CreatePushSubscription
- 25 QueryMemberCampaigns
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/liveb_rest/api/Member/InsertMemberDemography LIVEM: https://api.relateddigital.com/restm/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 field must contain the account-specific primary key column (EMAIL, KEY_ID). 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. Information When uploading member, format of GSM must be as below:
|
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/liveb_rest/api/Member/UpdateMemberDemography LIVEM: https://api.relateddigital.com/restm/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 field must contain the account-specific primary key column (EMAIL, KEY_ID). 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/liveb_rest/api/Member/AddToSendLists LIVEM: https://api.relateddigital.com/restm/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 field must contain the account-specific primary key column (EMAIL, KEY_ID). 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 |
QueryMemberId
URL | LIVE: https://api.relateddigital.com/resta/api/Member/QueryMemberId?Key=EMAIL&Value=test@test.com ECOMM: https://api.relateddigital.com/reste/api/Member/QueryMemberId?Key=EMAIL&Value=test@test.com LIVEB: https://api.relateddigital.com/liveb_rest/api/Member/QueryMemberId?Key=EMAIL&Value=test@test.com LIVEM: https://api.relateddigital.com/restm/api/Member/QueryMemberId?Key=EMAIL&Value=test@test.com |
|---|---|
Http verb | GET |
Parameters | Key(string): This field must contain the account-specific primary key column (EMAIL, KEY_ID). 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 interrupted. |
Header | Content-Type: application/json Authorization: The ticket issued by the system after successful login |
Body |
|
Sample Body |
|
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,69, 99, 107 |
QueryMemberDemography
URL | LIVE: https://api.relateddigital.com/resta/api/Member/QueryMemberDemography?Key=EMAIL&Value=test@test.com ECOMM: https://api.relateddigital.com/reste/api/Member/QueryMemberDemography?Key=EMAIL&Value=test@test.com LIVEM: https://api.relateddigital.com/restm/api/Member/QueryMemberDemography?Key=EMAIL&Value=test@test.com |
|---|---|
Http verb | GET |
Parameters | Key(string): This field must contain the account-specific primary key column (EMAIL, KEY_ID). 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. |
Header | Content-Type: application/json Authorization: The ticket issued by the system after successful login |
Body |
|
Sample Body |
|
Sample Response | { "DemographicData" : [ { "Key" : "", "Value": ""}, { "Key" : "", "Value": ""} ] "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,69, 99, 107 |
QuerySendLists
URL | LIVE: https://api.relateddigital.com/resta/api/Member/QuerySendLists?Key=EMAIL&Value=test@test.com ECOMM: https://api.relateddigital.com/reste/api/Member/QuerySendLists?Key=EMAIL&Value=test@test.com LIVEB: https://api.relateddigital.com/liveb_rest/api/Member/QuerySendLists?Key=EMAIL&Value=test@test.com LIVEM: https://api.relateddigital.com/restm/api/Member/QuerySendLists?Key=EMAIL&Value=test@test.com |
|---|---|
Http verb | GET |
Parameters | Key(string): This field must contain the account-specific primary key column (EMAIL, KEY_ID). 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. |
Header | Content-Type: application/json Authorization: The ticket issued by the system after successful login |
Body |
|
Sample Body |
|
Sample Response | { "SendLists" : [ { "ListName" : "", "GroupName": ""}, { "ListName" : "", "GroupName": ""} ] "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,69, 99, 107 |
RemoveFromSendLists
URL | LIVE: https://api.relateddigital.com/resta/api/Member/RemoveFromSendLists ECOMM: https://api.relateddigital.com/reste/api/Member/RemoveFromSendLists LIVEB: https://api.relateddigital.com/liveb_rest/api/Member/RemoveFromSendLists LIVEM: https://api.relateddigital.com/restm/api/Member/RemoveFromSendLists |
|---|---|
Http verb | DELETE |
Parameters |
|
Header | Content-Type: application/json Authorization: The ticket issued by the system after successful login |
Body | Key(string): This field must contain the account-specific primary key column (EMAIL, KEY_ID). Value(string): This is the value of the Key Column. If this value sent in wrong format, it will be ignored and the main process will not be interrupted. Move(bool): If the member is in no list after removal, this flag specifies whether the member should be completely deleted from the database or not. Use False if you do not want to delete the member. SendLists(SendList []): The member specified by Key and Value pair will be removed from these lists. |
Sample Body | { "Key" : "", "Value" : "", "DeleteIfInNoList" : 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,69, 99, 107,108 |