Campaigns

This API allows you to access campaigns.


GET /campaigns

Returns campaigns.

Parameter

Description

site_slug

Your Talkable Site ID. You can get this from your Talkable dashboard after you log in and create a site.

Example

GET https://www.talkable.com/api/v2/campaigns?site_slug=my-store

Sample response:

{
  "ok": true,
  "result": {
    "campaigns": [
      {
        "appearance": "inline",
        "id": 35944,
        "name": "API campaign",
        "new_customer": null,
        "origin_max_age": null,
        "origin_min_age": null,
        "tag_names": ["api"],
        "slug": 35944,
        "is_active": true,
        "status": "Live"
      },
      {
        "appearance": "popup",
        "id": 34601,
        "name": "PP campaign",
        "new_customer": null,
        "origin_max_age": null,
        "origin_min_age": null,
        "tag_names": ["default"],
        "slug": 34601,
        "is_active": true,
        "status": "Live"
      },
      {
        "appearance": "inline",
        "id": 34376,
        "name": "Inactive campaign",
        "new_customer": null,
        "origin_max_age": null,
        "origin_min_age": null,
        "tag_names": ["default"],
        "slug": 34376,
        "is_active": false,
        "status": "Disabled"
      }
    ]
  }
}