Versions Compared

Old Version 15

changes.mady.by.user MailUp Dev Team

Saved on

compared with

New Version 16

changes.mady.by.user MailUp Dev Team

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page provides you information about how to manage recipients (subscribe, unsubscribe, update personal data).

 

Tip
titleMailUp for beginners

Do you still get stuck with MailUp terminology? Please refer to Definitions and Recipients Management sections

 

 

On this page:

Table of Contents

 

Read personal data fields configuration

...

Description

...

Retrieve recipient dynamic field definitions.

...

HTTP Method

...

GET

...

URL

...

Code Block
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Recipient/DynamicFields

...

JSON request (example)

...

none

 

...

JSON response (example)

...

languagehtml/xml

...

This page provides you information about how to manage recipients (subscribe, unsubscribe, update personal data).

 

Tip
titleMailUp for beginners

Do you still get stuck with MailUp terminology? Please refer to Definitions and Recipients Management sections

 

 

On this page:

Table of Contents

 

...

Read personal data fields configuration

Description

Retrieve recipient dynamic field definitions.

HTTP Method

GET

URL

Code Block
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Recipient/DynamicFields

JSON request (example)

none

 

JSON response (example)

Expand
Code Block
languagehtml/xml
{"IsPaginated":true,"Items":[{"Description":"AllOrderedProductIDs","Id":26},{"Description":"LatestOrderIDTotalOrderedLast30d","Id":1325},{"Description":"CustomerIDTotalOrderedLast12m","Id":1224},{"Description":"phoneTotalOrdered","Id":1123},{"Description":"Gender LatestAbandonedCartID","Id":1022},{"Description":"AddressLatestAbandonedCartTotal","Id":921},{"Description":"RegionLatestAbandonedCartDate","Id":820},{"Description":"StateLatestShippedOrderID","Id":719}],{"PageNumberDescription":0"LatestShippedOrderDate","PageSizeId":2018},{"SkippedDescription":0"LatestOrderCategoryIDs","TotalElementsCountId":26}

Paging and filtering (example)

Use endpoint /Console/Recipient/DynamicFields?&orderby="Id+asc" to get a list that is ordered by Id

 

 

Retrieve all subscribed/unsubscribed from a list

You can subscribe a recipient to one or more lists or groups and you can also set personal data fields of the recipient.

Subscribed

Description

Retreive subscribers of specified list

HTTP Method

GET

URL

Code Block
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{ID_LIST}/Recipients/Subscribed

JSON request (example)

none

JSON response (example)

Expand
Code Block
languagehtml/xml
{"IsPaginated":false,"Items":[{"Email":"john@example.com","Fields":[{"Description":"FirstName","Id":117},{"Description":"LatestOrderProductIDs","Id":16},{"Description":"LatestOrderAmount","Id":15},{"Description":"LatestOrderDate","Id":14},{"Description":"LatestOrderID","Id":13},{"Description":"CustomerID","Id":12},{"Description":"phone","Id":11},{"Description":"Gender ","Id":10},{"Description":"Address","Id":9},{"Description":"Region","Id":8},{"Description":"State","Id":7}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":26}

Paging and filtering (example)

Use endpoint /Console/Recipient/DynamicFields?&orderby="Id+asc" to get a list that is ordered by Id

 

 

...

Retrieve all subscribed/unsubscribed from a list

You can subscribe a recipient to one or more lists or groups and you can also set personal data fields of the recipient.

Subscribed to a list

Description

Retreive subscribers of specified list

HTTP Method

GET

URL

Code Block
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{ID_LIST}/Recipients/Subscribed

JSON request (example)

none

JSON response (example)

Expand
Code Block
languagehtml/xml
{"IsPaginated":false,"Items":[{"Email":"john@example.com","Fields":[{"Description":"FirstName","Id":1,"Value":""},{"Description":"LastName","Id":2,"Value":""},{"Description":"Company","Id":3,"Value":""},{"Description":"City","Id":4,"Value":""},{"Description":"Province","Id":5,"Value":""},{"Description":"ZIP","Id":6,"Value":""},{"Description":"State","Id":7,"Value":""},{"Description":"Region","Id":8,"Value":""},{"Description":"Address","Id":9,"Value":""},{"Description":"Gender ","Id":10,"Value":""},{"Description":"phone","Id":11,"Value":""},{"Description":"CustomerID","Id":12,"Value":""},{"Description":"LatestOrderID","Id":13,"Value":""},{"Description":"LatestOrderDate","Id":14,"Value":""},{"Description":"LatestOrderAmount","Id":15,"Value":""},{"Description":"LatestOrderProductIDs","Id":16,"Value":""},{"Description":"LatestOrderCategoryIDs","Id":17,"Value":""},{"Description":"LatestShippedOrderDate","Id":18,"Value":""},{"Description":"LatestShippedOrderID","Id":19,"Value":""},{"Description":"LatestAbandonedCartDate","Id":20,"Value":""},{"Description":"LatestAbandonedCartTotal","Id":21,"Value":""},{"Description":"LatestAbandonedCartID","Id":22,"Value":""},{"Description":"TotalOrdered","Id":23,"Value":""},{"Description":"TotalOrderedLast12m","Id":24,"Value":""},{"Description":"TotalOrderedLast30d","Id":25,"Value":""},{"Description":"AllOrderedProductIDs","Id":26,"Value":""}],"MobileNumber":null,"MobilePrefix":null,"Name":null,"idRecipient":16},{"Email":"mary@example.com","Fields":[{"Description":"FirstName","Id":1,"Value":""},{"Description":"LastName","Id":2,"Value":""},{"Description":"Company","Id":3,"Value":""},{"Description":"City","Id":4,"Value":""},{"Description":"Province","Id":5,"Value":""},{"Description":"ZIP","Id":6,"Value":""},{"Description":"State","Id":7,"Value":""},{"Description":"Region","Id":8,"Value":""},{"Description":"LastNameAddress","Id":29,"Value":""},{"Description":"CompanyGender ","Id":310,"Value":""},{"Description":"Cityphone","Id":411,"Value":""},{"Description":"ProvinceCustomerID","Id":512,"Value":""},{"Description":"ZIPLatestOrderID","Id":613,"Value":""},{"Description":"StateLatestOrderDate","Id":714,"Value":""},{"Description":"RegionLatestOrderAmount","Id":815,"Value":""},{"Description":"AddressLatestOrderProductIDs","Id":916,"Value":""},{"Description":"Gender LatestOrderCategoryIDs","Id":1017,"Value":""},{"Description":"phoneLatestShippedOrderDate","Id":1118,"Value":""},{"Description":"CustomerIDLatestShippedOrderID","Id":1219,"Value":""},{"Description":"LatestOrderIDLatestAbandonedCartDate","Id":1320,"Value":""},{"Description":"LatestOrderDateLatestAbandonedCartTotal","Id":1421,"Value":""},{"Description":"LatestOrderAmountLatestAbandonedCartID","Id":1522,"Value":""},{"Description":"LatestOrderProductIDsTotalOrdered","Id":1623,"Value":""},{"Description":"LatestOrderCategoryIDsTotalOrderedLast12m","Id":1724,"Value":""},{"Description":"LatestShippedOrderDateTotalOrderedLast30d","Id":1825,"Value":""},{"Description":"LatestShippedOrderIDAllOrderedProductIDs","Id":1926,"Value":""},{"Description],"MobileNumber":null,"MobilePrefix":null,"LatestAbandonedCartDateName":null,"IdidRecipient":2015},{"ValueEmail":"susan@example.com"},"Fields":[{"Description":"LatestAbandonedCartTotalFirstName","Id":211,"Value":"Susan"},{"Description":"LatestAbandonedCartIDLastName","Id":222,"Value":"Smith"},{"Description":"TotalOrderedCompany","Id":233,"Value":"ACME"},{"Description":"TotalOrderedLast12mCity","Id":244,"Value":"Milan"},{"Description":"TotalOrderedLast30dProvince","Id":255,"Value":"MI"},{"Description":"AllOrderedProductIDsZIP","Id":266,"Value":"20100"}],{"MobileNumberDescription":null,"MobilePrefixState":null,"NameId":null7,"idRecipient":16},{"Email":"mary@example.com","Fields":[Value":"Italy"},{"Description":"FirstNameRegion","Id":18,"Value":""},{"Description":"LastNameAddress","Id":29,"Value":""},{"Description":"CompanyGender ","Id":310,"Value":"male"},{"Description":"Cityphone","Id":411,"Value":"1234567"},{"Description":"ProvinceCustomerID","Id":512,"Value":"1"},{"Description":"ZIPLatestOrderID","Id":613,"Value":"6"},{"Description":"StateLatestOrderDate","Id":714,"Value":"1397470773"},{"Description":"RegionLatestOrderAmount","Id":815,"Value":"1000"},{"Description":"AddressLatestOrderProductIDs","Id":916,"Value":"1"},{"Description":"Gender LatestOrderCategoryIDs","Id":1017,"Value":"1"},{"Description":"phoneLatestShippedOrderDate","Id":1118,"Value":"1397470973"},{"Description":"CustomerIDLatestShippedOrderID","Id":1219,"Value":"6"},{"Description":"LatestOrderIDLatestAbandonedCartDate","Id":1320,"Value":"1397468462"},{"Description":"LatestOrderDateLatestAbandonedCartTotal","Id":1421,"Value":"200"},{"Description":"LatestOrderAmountLatestAbandonedCartID","Id":1522,"Value":"1"},{"Description":"LatestOrderProductIDsTotalOrdered","Id":1623,"Value":"1200"},{"Description":"LatestOrderCategoryIDsTotalOrderedLast12m","Id":1724,"Value":"1200"},{"Description":"LatestShippedOrderDateTotalOrderedLast30d","Id":1825,"Value":"1200"},{"Description":"LatestShippedOrderIDAllOrderedProductIDs","Id":1926,"Value":"1,2"}],{"DescriptionMobileNumber":"LatestAbandonedCartDate","IdMobilePrefix":20,"Value":""},{"DescriptionName":"LatestAbandonedCartTotalTest","IdidRecipient":2114},{"ValueEmail":"peter@example.com"},"Fields":[{"Description":"LatestAbandonedCartIDFirstName","Id":221,"Value":""},{"Description":"TotalOrderedLastName","Id":232,"Value":""},{"Description":"TotalOrderedLast12mCompany","Id":243,"Value":""},{"Description":"TotalOrderedLast30dCity","Id":254,"Value":""},{"Description":"AllOrderedProductIDsProvince","Id":265,"Value":""}],{"MobileNumberDescription":null,"MobilePrefixZIP":null,"NameId":null,"idRecipient":15},{"Email6,"Value":"susan@example.com"},"Fields":[{"Description":"FirstNameState","Id":17,"Value":"Susan"},{"Description":"LastNameRegion","Id":28,"Value":"Smith"},{"Description":"CompanyAddress","Id":39,"Value":"ACME"},{"Description":"CityGender ","Id":410,"Value":"Milan"},{"Description":"Provincephone","Id":511,"Value":"MI"},{"Description":"ZIPCustomerID","Id":612,"Value":"20100"},{"Description":"StateLatestOrderID","Id":713,"Value":"Italy"},{"Description":"RegionLatestOrderDate","Id":814,"Value":""},{"Description":"AddressLatestOrderAmount","Id":915,"Value":""},{"Description":"Gender LatestOrderProductIDs","Id":1016,"Value":"male"},{"Description":"phoneLatestOrderCategoryIDs","Id":1117,"Value":"1234567"},{"Description":"CustomerIDLatestShippedOrderDate","Id":1218,"Value":"1"},{"Description":"LatestOrderIDLatestShippedOrderID","Id":1319,"Value":"6"},{"Description":"LatestOrderDateLatestAbandonedCartDate","Id":1420,"Value":"1397470773"},{"Description":"LatestOrderAmountLatestAbandonedCartTotal","Id":1521,"Value":"1000"},{"Description":"LatestOrderProductIDsLatestAbandonedCartID","Id":1622,"Value":"1"},{"Description":"LatestOrderCategoryIDsTotalOrdered","Id":1723,"Value":"1"},{"Description":"LatestShippedOrderDateTotalOrderedLast12m","Id":1824,"Value":"1397470973"},{"Description":"LatestShippedOrderIDTotalOrderedLast30d","Id":1925,"Value":"6"},{"Description":"LatestAbandonedCartDateAllOrderedProductIDs","Id":2026,"Value":"1397468462"}],{"DescriptionMobileNumber":null,"LatestAbandonedCartTotalMobilePrefix":null,"IdName":21null,"ValueidRecipient":13}],"200PageNumber"}:0,{"DescriptionPageSize":20,"LatestAbandonedCartIDSkipped":0,"IdTotalElementsCount":22,"Value":"1"},{"Description":"TotalOrdered","Id":23,"Value":"1200"},{"Description":"TotalOrderedLast12m","Id":24,"Value":"1200"},{"Description":"TotalOrderedLast30d","Id":25,"Value":"1200"},{"Description":"AllOrderedProductIDs","Id":26,"Value":"1,2"}],"MobileNumber":"","MobilePrefix":"","Name":"Test","idRecipient":14},4}

Paging and filtering (example)

2 items per page, get first page (count starts from zero)

  • https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/1/Recipients/Subscribed?PageNumber=0&PageSize=2

Retreive all the subscribers of a specified list whose Email contains 'example' filterby="Email.Contains('example')" and sort them by Email orderby="Email asc". Parameter names can be retreived from the response body. Please note that "Contains" is case sensitive.

  • https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/1/Recipients/Subscribed?filterby="Email.Contains(%27example%27)"&orderby="Email+asc"

 

 

Unsubscribed from a list

As for "subscribed", but in this case the endpoint is /Console/List/{ID_LIST}/Recipients/Unsubscribed


 

Group members

 

Description

Retreive email subscribers that belong to specified group. Group members that are not subscribed on email channel are not returned

HTTP Method

GET

URL

Code Block
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Group/{id_Group}/Recipients

JSON request (example)

none

JSON response (example)

Expand
Code Block
languagehtml/xml
{"IsPaginated":false,"Items":[{"Email":"peter@example.com","Fields":[{"Description":"FirstName","Id":1,"Value":""},{"Description":"LastName","Id":2,"Value":""},{"Description":"Company","Id":3,"Value":""},{"Description":"City","Id":4,"Value":""},{"Description":"Province","Id":5,"Value":""},{"Description":"ZIP","Id":6,"Value":""},{"Description":"State","Id":7,"Value":""},{"Description":"Region","Id":8,"Value":""},{"Description":"Address","Id":9,"Value":""},{"Description":"Gender ","Id":10,"Value":""},{"Description":"phone","Id":11,"Value":""},{"Description":"CustomerID","Id":12,"Value":""},{"Description":"LatestOrderID","Id":13,"Value":""},{"Description":"LatestOrderDate","Id":14,"Value":""},{"Description":"LatestOrderAmount","Id":15,"Value":""},{"Description":"LatestOrderProductIDs","Id":16,"Value":""},{"Description":"LatestOrderCategoryIDs","Id":17,"Value":""},{"Description":"LatestShippedOrderDate","Id":18,"Value":""},{"Description":"LatestShippedOrderID","Id":19,"Value":""},{"Description":"LatestAbandonedCartDate","Id":20,"Value":""},{"Description":"LatestAbandonedCartTotal","Id":21,"Value":""},{"Description":"LatestAbandonedCartID","Id":22,"Value":""},{"Description":"TotalOrdered","Id":23,"Value":""},{"Description":"TotalOrderedLast12m","Id":24,"Value":""},{"Description":"TotalOrderedLast30d","Id":25,"Value":""},{"Description":"AllOrderedProductIDs","Id":26,"Value":""}],"MobileNumber":null,"MobilePrefix":null,"Name":null,"idRecipient":13}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":41}

Paging and filtering (example)

2 items per page, get first page (count starts from zero)

  • https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/ListGroup/127/Recipients/Subscribed?PageNumber=0&PageSize=2

Retreive all the subscribers of a specified list whose Email contains 'example' filterby="Email.Contains('example')" and sort them by Email orderby="Email asc". Parameter names can be retreived from the response body. Please note that "Contains" is case sensitive.

  • https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/ListGroup/127/Recipients/Subscribed?filterby="Email.Contains(%27example%27)"&orderby="Email+asc"

 

 

Unsubscribed

As for "subscribed", but in this case the endpoint is /Console/List/{ID_LIST}/Recipients/Unsubscribed 


 

...

Asynchronous import of recipients

...

Check if a subscriber exists

With this method you can also retreive recipientID and personal data fields of specified subscriber

Description

Check subscriber and retreive data

HTTP Method

GET

URL

https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/3/Recipients/Subscribed?filterby="Email.Contains('{Email}')"

see example in the "paging and filtering" row

JSON request (example)

none

 

JSON response (example)

Expand

when the specified recipient belongs to list suscribers the response contains the personal data fields of the recipient

Code Block
languagehtml/xml
{"IsPaginated":false,"Items":[{"Email":"peter@example.com","Fields":[{"Description":"FirstName","Id":1,"Value":""},{"Description":"LastName","Id":2,"Value":""},{"Description":"Company","Id":3,"Value":""},{"Description":"City","Id":4,"Value":""},{"Description":"Province","Id":5,"Value":""},{"Description":"ZIP","Id":6,"Value":""},{"Description":"State","Id":7,"Value":""},{"Description":"Region","Id":8,"Value":""},{"Description":"Address","Id":9,"Value":""},{"Description":"Gender ","Id":10,"Value":""},{"Description":"phone","Id":11,"Value":""},{"Description":"CustomerID","Id":12,"Value":""},{"Description":"LatestOrderID","Id":13,"Value":""},{"Description":"LatestOrderDate","Id":14,"Value":""},{"Description":"LatestOrderAmount","Id":15,"Value":""},{"Description":"LatestOrderProductIDs","Id":16,"Value":""},{"Description":"LatestOrderCategoryIDs","Id":17,"Value":""},{"Description":"LatestShippedOrderDate","Id":18,"Value":""},{"Description":"LatestShippedOrderID","Id":19,"Value":""},{"Description":"LatestAbandonedCartDate","Id":20,"Value":""},{"Description":"LatestAbandonedCartTotal","Id":21,"Value":""},{"Description":"LatestAbandonedCartID","Id":22,"Value":""},{"Description":"TotalOrdered","Id":23,"Value":""},{"Description":"TotalOrderedLast12m","Id":24,"Value":""},{"Description":"TotalOrderedLast30d","Id":25,"Value":""},{"Description":"AllOrderedProductIDs","Id":26,"Value":""}],"MobileNumber":null,"MobilePrefix":null,"Name":null,"idRecipient":13}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":1}

when the specified recipient does not belong to list subscribers (i.e. it may be not existing but also unsubscribed or subscribed only to other MailUp lists for that console account) an empty list is returned

Code Block
{"IsPaginated":false,"Items":[],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":0}

Paging and filtering (example)

https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/3/Recipients/Subscribed?filterby="Email.Contains(%27peter@example.com%27)"


 

Update personal data of an existing subscriber

...

  • Recipient ID, which can be retrieved with the operation listed above (Check if a subscriber exists)
  • The IDs of the fields to be updated

Description

Retrieve recipient dynamic field definitions.

HTTP Method

PUT

URL

https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Recipient/DynamicFields

JSON request (example)

Modifying the "Region" field

Code Block
[{
	"Email":"test25@example.com",
	"Fields":[{
		"Description":"Region",
		"Id":8,
		"Value":"England"
	}],
	"Name":"Test",
	"idRecipient":23
}]

 

 

JSON response (example)

Expand
Code Block
{"IsPaginated":false,"Items":[{"Email":"test25@example.com","Fields":[{"Description":"FirstName","Id":1,"Value":""},{"Description":"LastName","Id":2,"Value":""},{"Description":"Company","Id":3,"Value":""},{"Description":"City","Id":4,"Value":""},{"Description":"Province","Id":5,"Value":""},{"Description":"ZIP","Id":6,"Value":""},{"Description":"State","Id":7,"Value":""},{"Description":"Region","Id":8,"Value":"Italy"},{"Description":"Address","Id":9,"Value":""},{"Description":"Gender ","Id":10,"Value":""},{"Description":"phone","Id":11,"Value":""},{"Description":"CustomerID","Id":12,"Value":""},{"Description":"LatestOrderID","Id":13,"Value":""},{"Description":"LatestOrderDate","Id":14,"Value":""},{"Description":"LatestOrderAmount","Id":15,"Value":""},{"Description":"LatestOrderProductIDs","Id":16,"Value":""},{"Description":"LatestOrderCategoryIDs","Id":17,"Value":""},{"Description":"LatestShippedOrderDate","Id":18,"Value":""},{"Description":"LatestShippedOrderID","Id":19,"Value":""},{"Description":"LatestAbandonedCartDate","Id":20,"Value":""},{"Description":"LatestAbandonedCartTotal","Id":21,"Value":""},{"Description":"LatestAbandonedCartID","Id":22,"Value":""},{"Description":"TotalOrdered","Id":23,"Value":""},{"Description":"TotalOrderedLast12m","Id":24,"Value":""},{"Description":"TotalOrderedLast30d","Id":25,"Value":""},{"Description":"AllOrderedProductIDs","Id":26,"Value":""}],"MobileNumber":null,"MobilePrefix":null,"Name":null,"idRecipient":23}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":1}

Paging and filtering (example)

none


...