Referral Campaigns

Endpoints that allow you to work with your referral campaigns.

Get Campaigns

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

Returns all of your campaigns. At the moment you're only allowed to have one campaign per Sparkloop account.

200 Campaigns successfully retrieved.

{ 
  "campaigns": [
    <Campaign Object>,
    <Campaign Object>,
    <Campaign Object>
  ]
}

401

Missing API key

{ "error": "API key is missing!" }

User not found for API key

{ "error": "User not found!" }

Get Campaign

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

Returns a campaign.

Path Parameters

Name	Type	Description
identifier*	string	Campaign's UUID, for example MF9a78983d1c

Headers

Name	Type	Description
X-Api-Key*	string	API key

200

{ 
  "campaign": <Campaign Object>
}

401

Missing API key

{ "error": "API key is missing!" }

User not found for API key

{ "error": "User not found!" }

404

{ "error": "Campaign MF9a78983d1c not found!"}

Update Campaign

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

Updates the campaign

Path Parameters

Name	Type	Description
identifier*	string	Campaign's UUID, for example MF9a78983d1c

Headers

Name	Type	Description
X-Api-Key*	string	API key

Request Body

Name	Type	Description
name	string	Campaign's name

200

{
  "campaign": <Campaign Object>
}

401

Missing API key

{ "error": "API key is missing!" }

User not found for API key

{ "error": "User not found!" }

404

{ "error": "Campaign MF9a78983d1c not found!"}