Campaigns

Create campaign

Creates a new campaign in your organization.

POST
/campaigns

Authorization

Authorization
Required
Bearer <token>

API key authentication. Use your API key as the bearer token.

In: header

Request Body

application/jsonRequired

name
Required
string

Campaign name (for internal use, affiliates do not see this name)

commission_type
Required
string

Whether the campaign gives percentage based or fixed amount commissions

Value in: "percentage" | "fixed"

commission_amount
Required
number

Percentage or fixed amount commission rate (e.g. 20 would mean 20% or $20)

code_mode
Required
string

Referral code type. "link" creates affiliate links, "coupon" creates promo codes, "both" creates both.

Value in: "link" | "coupon" | "both"

website_urlstring

Campaign website URL. Required when code_mode is "link" or "both".

reference_couponstring

Stripe coupon ID that's used to create affiliate promo codes. Required when code_mode is "coupon" or "both".

is_defaultboolean

Default: false
curl -X POST "https://www.promotekit.com/api/v1/campaigns" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "commission_type": "percentage",
    "commission_amount": 0,
    "code_mode": "link",
    "website_url": "string",
    "reference_coupon": "string",
    "is_default": false
  }'

Campaign created

{
  "success": true,
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "website_url": "string",
    "commission_type": "percentage",
    "commission_amount": 0,
    "is_default": true,
    "limit_type": "string",
    "limit_amount": 0,
    "code_mode": "link",
    "reference_coupon": "string",
    "custom_commission_type": "string",
    "welcome_message": "string",
    "approval_needed": true,
    "collect_details": true,
    "details_text": "string",
    "hide_emails": true,
    "dashboard_text": "string",
    "cookie_duration": 0,
    "first_payment_commission": {
      "enabled": true,
      "type": "string",
      "amount": 0
    }
  }
}

Previous

Get campaign GET

Next

Update campaign PUT