Publications

Create a publication

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

Request Body

Name	Type	Description
name*	string	Name
description	string	Description
categories*	array	Categories to which this publication belongs, at least one and at most three categories are allowed. e.g. [marketing, tech] List of all available categories: marketing, tech, food & drink, sports, health & fitness, news, finance, web3.0, TV & movie, literature, science, politics, lifestyle, business, art & design, travel, media
list_id	string	The ID of the ESP list you want to use for this publication. Some ESPs like ConvertKit don't use lists so you can leave the list_id empty in that case.
status	string	Status of the publication. active or archived
logo*	image	Logo of the publication. Must be png, jpeg, or jpg, and smaller than 1MB in size.
audience_gender*	string	Gender composition of the publication audience. It can be almost_all_male, mainly_male, mixed, mainly_female or almost_all_female
income_levels*	array	Income levels of the publication audience. At least one is required. e.g. [$150k+] List of all available income levels: less than $20k, $20k - $50k, $50k - $75k, $75k - $100k, $100k - $150k, $150k+
age_ranges*	array	Age ranges the publication audience belongs to. At least one is required. e.g. [under 18] List of all available age ranges: under 18, 18 - 24, 25 - 39, 40 - 59, 60+

201: Created

{
  "publication": {
    "uuid": "pub_4bc1056297",
    "name": "My first newsletter",
    "description": "Publication for my first newsletter",
    "partner_categories": ["marketing", "tech"],
    "list_id": "c34kko0",
    "status": "active",
    "enabled_partner_program": true,
    "created_at": "2021-03-24T11:55:02.113Z"
  }
}

400

Get publications

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

Publications are ordered descendingly by created_at, meaning the first page shows the latest publications.

200 Used query params ?page=1&per_page=2

{
  "publications": [
    {
      "uuid": "pub_4bc1056297",
      "name": "My first newsletter",
      "description": "Publication for my first newsletter",
      "partner_categories": ["marketing", "tech"],
      "list_id": "c34kko0",
      "status": "active",
      "enabled_partner_program": true,
      "created_at": "2021-03-24T11:55:02.113Z"
    },
    {
      "uuid": "sub_869976268c",
      "name": "My second newsletter",
      "description": "Publication for my second newsletter",
      "partner_categories": ["lifestyle"],
      "list_id": "ppelz34",
      "status": "active",
      "enabled_partner_program": false,    
      "created_at": "2021-03-27T12:43:05.073Z"
    }
  ],
  "meta": {
    "per_page": 2,
    "page": 1,
    "total_pages": 2,
    "total_publications": 4
  }
}

Get a publication

GET https://api.sparkloop.app/v2/publications/:uuid

Returns a single publication by UUID

Path Parameters

Name	Type	Description
uuid*	string	Publication's UUID

200

{
  "publication": {
    "uuid": "pub_4bc1056297",
    "name": "My first newsletter",
    "description": "Publication for my first newsletter",
    "partner_categories": ["marketing", "tech"],
    "list_id": "c34kko0",
    "status": "active",
    "enabled_partner_program": true,
    "created_at": "2021-03-24T11:55:02.113Z"
  }
}

404

Publication not found

{
    "error": "Publication pub_4bc10562d97 not found!"
}

Update publication

PUT https://api.sparkloop.app/v2/publications/:uuid

Path Parameters

Name	Type	Description
uuid*	string	Publication's UUID

Request Body

Name	Type	Description
name	string	Name
description	string	Description
categories	array	Categories to which this publication belongs, at least one and at most three categories are allowed. e.g. [marketing, tech] List of all available categories: marketing, tech, food & drink, sports, health & fitness, news, finance, web3.0, TV & movie, literature, science, politics, lifestyle, business, art & design, travel, media
logo	String	Logo of the publication. Must be png, jpeg, or jpg, and smaller than 1MB in size.
status	String	Status of the publication. active or archived
enabled_partner_program	boolean	Set to true to enable the partner program. Set to false to disable it.
audience_gender	string	Gender composition of the publication audience. It can be almost_all_male, mainly_male, mixed, mainly_female or almost_all_female
income_levels	array	Income levels of the publication audience. At least one is required. e.g. [$150k+] List of all available income levels: less than $20k, $20k - $50k, $50k - $75k, $75k - $100k, $100k - $150k, $150k+
age_ranges	array	Age ranges the publication audience belongs to. At least one is required. e.g. [under 18] List of all available age ranges: under 18, 18 - 24, 25 - 39, 40 - 59, 60+

200 Returns the subscriber.

{
  "publication": {
    "uuid": "pub_4bc1056297",
    "name": "My first newsletter",
    "description": "Publication for my first newsletter",
    "partner_categories": ["marketing", "tech"],
    "list_id": "c34kko0",
    "status": "active",
    "enabled_partner_program": true,
    "created_at": "2021-03-24T11:55:02.113Z"
  }
}

400 When you try setting status to something other than unsubscribed or confirmed.

404

Publication not found

{
    "error": "Publication pub_34c8e39ca4 not found!"
}

Delete publication

DELETE https://api.sparkloop.app/v2/publications/:uuid

Path Parameters

Name	Type	Description
uuid*	string	Publication's UUID

200

{
    "message": "Successfully deleted publication pub_34c8e39cf4"
}

400

{
    "error": "Failed to delete publication pub_34c8e39ca4"
}

404

Publication not found

{
    "error": "Publication pub_34c8e39ca4 not found!"
}