BackofficeApi

<back to all web services

NewsletterRecipientsRequest

Backoffice
Requires Authentication
Required role:Backoffice
The following routes are available for this service:
GET/newsletter/recipients
NewsletterRecipientsResponse Parameters:
NameParameterData TypeRequiredDescription
NewsletterRecipientsformList<NewsletterRecipientDto>Yes
NewsletterRecipientDto Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringYes
LastNameformstringYes
EmailformstringYes
AreaOfInterestformNewsletterAreaOfInterestNo
PhoneformstringYes
NewsletterAreaOfInterest Enum:
RestaurantCafeBarClub
Fashion
Press
Blogger
PrivateIndividual

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /newsletter/recipients HTTP/1.1 
Host: backoffice-api.brovs.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"newsletterRecipients":[{"firstName":"String","lastName":"String","email":"String","areaOfInterest":"RestaurantCafeBarClub","phone":"String"}]}