Subscribers
Manage subscribers.
Get Subscribers
GET https://api.bigcommerce.com/stores/{store_hash}/v3/customers/subscribersRequest
Returns a list of Subscribers. Optional filter parameters can be passed in.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Body
object | application/json
Response payload for the BigCommerce API.
dataarray[]
example
Create a Subscriber
POST https://api.bigcommerce.com/stores/{store_hash}/v3/customers/subscribersRequest
Creates a Subscriber.
Required Fields
Read Only Fields
- id
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
Body
application/json
The model for a POST to create a subscriber.
example
Response
Body
object | application/json
data
Full subscriber object returned in responses.
example
Delete Subscribers
DELETE https://api.bigcommerce.com/stores/{store_hash}/v3/customers/subscribersRequest
By default, it deletes all subscribers. Use a filter to avoid deleting all subscribers in a store.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
example
Response
Get a Subscriber
GET https://api.bigcommerce.com/stores/{store_hash}/v3/customers/subscribers/{subscriber_id}Request
Returns a Subscriber.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- subscriber_id in path - integerrequired
The ID of the
Subscriber
requested.
example
Response
Body
object | application/json
data
Full subscriber object returned in responses.
example
Update a Subscriber
PUT https://api.bigcommerce.com/stores/{store_hash}/v3/customers/subscribers/{subscriber_id}Request
Updates a Subscriber.
Read Only Fields
- id
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- subscriber_id in path - integerrequired
The ID of the
Subscriber
requested.
Body
application/json
The model for a PUT to update a subscriber.
example
Response
Body
object | application/json
data
Full subscriber object returned in responses.
example
Delete a Subscriber
DELETE https://api.bigcommerce.com/stores/{store_hash}/v3/customers/subscribers/{subscriber_id}Request
Deletes a Subscriber.
Authentication
- X-Auth-Token in headerrequired
Parameters
- store_hash in path - string
- subscriber_id in path - integerrequired
The ID of the
Subscriber
requested.
example
Response
Did you find what you were looking for?