/
/
/
/
Subscriber (XC\NewsletterSubscriptions)
Subscriber (XC\NewsletterSubscriptions)
This repo stores all newsletter subscribers
GET
Retrieve newsletter subscribers by conditions
_cnd[limit]
array
Sets the offset (first item) and the limit (second item)
_cnd[orderBy]
array
Sets sorting order field
default Success <XLite\Module\XC\NewsletterSubscriptions\Model\Subscriber>[] array
Sample response
[{"id":82,"email":"example","profile":false}]
_cnd[limit]
array
Sets the offset (first item) and the limit (second item)
_cnd[orderBy]
array
Sets sorting order field
default Success <XLite\Module\XC\NewsletterSubscriptions\Model\Subscriber>[] array
Sample response
[{"id":82,"email":"example","profile":false}]
GET
Retrieve newsletter subscriber by id
id
integer Required
Id value of the Subscriber object
default Success <XLite\Module\XC\NewsletterSubscriptions\Model\Subscriber>
Sample response
{"id":82,"email":"example","profile":false}
id
integer
Product unique ID
email
string
Code
profile
boolean
Enabled status
id
integer Required
Id value of the Subscriber object
default Success <XLite\Module\XC\NewsletterSubscriptions\Model\Subscriber>
Sample response
{"id":82,"email":"example","profile":false}
id
integer
Product unique ID
email
string
Code
profile
boolean
Enabled status
PUT
Update newsletter subscriber by id
id
integer Required
Id value of the Subscriber object
<XLite\Module\XC\NewsletterSubscriptions\Model\Subscriber>
id
integer
Product unique ID
email
string
Code
profile
boolean
Enabled status
default Success <XLite\Module\XC\NewsletterSubscriptions\Model\Subscriber>
Sample response
{"id":82,"email":"example","profile":false}
id
integer
Product unique ID
email
string
Code
profile
boolean
Enabled status
id
integer Required
Id value of the Subscriber object
<XLite\Module\XC\NewsletterSubscriptions\Model\Subscriber>
id
integer
Product unique ID
email
string
Code
profile
boolean
Enabled status
default Success <XLite\Module\XC\NewsletterSubscriptions\Model\Subscriber>
Sample response
{"id":82,"email":"example","profile":false}
id
integer
Product unique ID
email
string
Code
profile
boolean
Enabled status
DELETE
Delete newsletter subscriber by id
id
integer Required
Id value of the Subscriber object
default Success <XLite\Module\XC\NewsletterSubscriptions\Model\Subscriber>
Sample response
{"id":82,"email":"example","profile":false}
id
integer
Product unique ID
email
string
Code
profile
boolean
Enabled status
id
integer Required
Id value of the Subscriber object
default Success <XLite\Module\XC\NewsletterSubscriptions\Model\Subscriber>
Sample response
{"id":82,"email":"example","profile":false}
id
integer
Product unique ID
email
string
Code
profile
boolean
Enabled status
POST
Add newsletter subscriber
<XLite\Module\XC\NewsletterSubscriptions\Model\Subscriber>
id
integer
Product unique ID
email
string
Code
profile
boolean
Enabled status
default Success <XLite\Module\XC\NewsletterSubscriptions\Model\Subscriber>
Sample response
{"id":82,"email":"example","profile":false}
id
integer
Product unique ID
email
string
Code
profile
boolean
Enabled status
<XLite\Module\XC\NewsletterSubscriptions\Model\Subscriber>
id
integer
Product unique ID
email
string
Code
profile
boolean
Enabled status
default Success <XLite\Module\XC\NewsletterSubscriptions\Model\Subscriber>
Sample response
{"id":82,"email":"example","profile":false}
id
integer
Product unique ID
email
string
Code
profile
boolean
Enabled status