Subscribers

Create a subscriber

POST https://api.sparkloop.app/v2/subscribers

Request Body

{
    "subscriber": <Subscriber Object>
}

Get subscribers

GET https://api.sparkloop.app/v2/subscribers

Subscribers are ordered in desceding order by created_at, meaning the first page shows the latest subscribers.

Query Parameters

{
  "subscribers": [
    <Subscriber Object>,
    <Subscriber Object>,
    <Subscriber Object>,
  ],
  "meta": {
    "per_page": 2,
    "page": 2,
    "total_pages": 3,
    "total_subscribers": 6
  }
}

Get a subscriber

GET https://api.sparkloop.app/v2/subscribers/:identifier

Returns a single subscriber by email address or UUID

Path Parameters

Query Parameters

{
  "subscriber": <Subscriber Object>
}

Update subscriber

PUT https://api.sparkloop.app/v2/subscribers/:identifier

Update a subscriber's name, email address or status

Path Parameters

Request Body

{
    "subscriber": <Subscriber Object>
}

Unsubscribe subscriber

PUT https://api.sparkloop.app/v2/subscribers/:identifier/unsubscribe

Unsubscribe a subscriber

Path Parameters

{
    "subscriber": <Subscriber Object>
}

Reject subscriber

PUT https://api.sparkloop.app/v2/subscribers/:identifier/reject

Reject a pending subscriber (acquired via partner program or referral program)

Path Parameters

{
    "subscriber": <Subscriber Object>
}

Delete a subscriber

DELETE https://api.sparkloop.app/v2/subscribers/:identifier

Path Parameters

{
    "message": "Successfully deleted subscriber sub_34c8e39cf4"
}

Last updated