Campaign Registration

Campaign registration is handled by the create endpoint.

curl -X "POST" "https://api.clsfy.me/v1/snowball/campaigns" \
     -H 'X-API-Key: 1234' \
     -H 'Content-Type: application/json; charset=utf-8' \
     -d $'{
  "client_id": "1",
  "description": "H1 2026 Awesome New Campaign"
}'

The expected response is:

{
  "id": 609,
  "client_id": 500,
  "description": "H1 2026 Awesome New Campaign",
  "created_date": "2025-12-30T20:33:44.828076Z",
  "last_updated_date": "2025-12-30T20:33:44.828076Z",
  "deleted": false
}

The client ID is associated with your API Key provided by sales. Your new campaign now has the registered ID 609!

Listing active campaigns

You can list out all the campaigns associated with your API key like so:

## list campaigns
curl "https://api.clsfy.me/v1/snowball/campaigns" \
     -H 'X-API-Key: 1234'

This will produce:

[
  {
    "id": 608,
    "client_id": 500,
    "description": "H2 2025 Christmas Campaign",
    "created_date": "2025-12-29T15:42:04.393779Z",
    "last_updated_date": "2025-12-29T15:42:04.393779Z",
    "deleted": false
  },
  {
    "id": 609,
    "client_id": 500,
    "description": "H1 2026 Awesome New Campaign",
    "created_date": "2025-12-29T00:19:45.215766Z",
    "last_updated_date": "2025-12-29T00:19:45.215766Z",
    "deleted": false
  }
]