Docs
Management API
Subscribers

Subscribers

Manage subscribers.

Get Subscribers

GET /customers/subscribers

Request

Returns a list of Subscribers. Optional filter parameters can be passed in.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

example

Response

Body

object | application/json

Response payload for the BigCommerce API.

  • data    array[]

  • meta    object

    Data about the response, including pagination and collection totals.

example

Create a Subscriber

POST /customers/subscribers

Request

Creates a Subscriber.

Required Fields

  • email

Read Only Fields

  • id

Authentication

  • X-Auth-Token in header
    required

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.

  • meta    object

    Response metadata.

example

Delete Subscribers

DELETE /customers/subscribers

Request

By default, it deletes all subscribers. Use a filter to avoid deleting all subscribers in a store.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string

example

Response

Get a Subscriber

GET /customers/subscribers/{subscriber_id}

Request

Returns a Subscriber.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • subscriber_id in path - integer
    required

    The ID of the Subscriber requested.

example

Response

Body

object | application/json

  • data

    Full subscriber object returned in responses.

  • meta    object

    Response metadata.

example

Update a Subscriber

PUT /customers/subscribers/{subscriber_id}

Request

Updates a Subscriber.

Read Only Fields

  • id

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • subscriber_id in path - integer
    required

    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.

  • meta    object

    Response metadata.

example

Delete a Subscriber

DELETE /customers/subscribers/{subscriber_id}

Request

Deletes a Subscriber.

Authentication

  • X-Auth-Token in header
    required

Parameters

  • store_hash in path - string
  • subscriber_id in path - integer
    required

    The ID of the Subscriber requested.

example

Response

Did you find what you were looking for?
Get System LogsGet Subscribers