Subscribers

Creates, retrieves, updates, and deletes newsletter subscribers.

Table Specific Information

The driver uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:

The rest of the filter is executed client-side within the driver.

For example, the following queries are processed server-side:

SELECT * FROM Subscribers WHERE Id = 10

SELECT * FROM Subscribers WHERE Email = '[email protected]'

To insert a subscriber, specify at least the Email column.

INSERT INTO Subscribers (Email, FirstName, LastName, Source) VALUES ('[email protected]', 'Test', 'Subscriber', 'custom')

UPDATE Subscribers SET FirstName = 'Updated' WHERE Id = 10

DELETE FROM Subscribers WHERE Id = 10


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	The unique identifier of the subscriber.
Email	String	False	The subscriber's email address. Must be unique.
FirstName	String	False	The subscriber's first name.
LastName	String	False	The subscriber's last name.
Source	String	False	How the subscriber was added to the list. The allowed values are storefront, order, custom.
OrderId	Integer	False	The Id of the order associated with this subscriber, if the subscriber was created from an order.
ChannelId	Integer	False	The Id of the channel the subscriber signed up through.
Consents	String	False	A JSON-formatted array of consent types the subscriber has agreed to, for example marketing_newsletter or abandoned_cart.
DateCreated	Datetime	True	Date and time the subscriber was created.
DateModified	Datetime	True	Date and time the subscriber was last modified.