Create a campaign

Creates a new affiliate campaign for the authenticated merchant account. Commission duration is controlled by commissionRecurring and recurringMonthsLimit. commissionRecurring=false means only the first attributed payment earns commission. commissionRecurring=true with recurringMonthsLimit=null means lifetime recurring commissions. commissionRecurring=true with recurringMonthsLimit=12 means recurring payments remain commissionable for 12 months. Limited windows start at the first attributed payment / initial conversion, not the first click.

Authorization

bearerAuth

AuthorizationBearer <token>

API key issued from the merchant dashboard. Sent as Authorization: Bearer <token>. Used by the SDK and any direct server-to-server integration.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 100

description?string

Lengthlength <= 500

landingUrl*string

Formaturi

commissionRate*number

Range0 <= value <= 999999999

commissionType*string

Value in"PERCENTAGE" | "FIXED"

commissionTiers?array<>

Itemsitems <= 10

attributionWindowDays?||

attributionModel?string

Default"LAST_CLICK"

Value in"FIRST_CLICK" | "LAST_CLICK"

commissionRecurring?boolean

Set false to commission only the first attributed payment. Set true to apply recurring commission rules from recurringMonthsLimit.

Defaulttrue

recurringMonthsLimit?integer

Number of months after the first attributed payment during which recurring payments earn commission. Null means lifetime recurring commissions when commissionRecurring is true.

Range0 <= value

budgetLimit?number

Range0 <= value <= 999999999

conversionLimit?integer

Range0 <= value

startDate?string

Formatdate-time

endDate?string

Formatdate-time

publicDiscoveryEnabled?boolean

Defaultfalse

priority?integer

Default0

Range0 <= value

routingWeight?integer

Default100

Range1 <= value <= 1000

minTotalRevenue?number

Range0 <= value <= 999999999

minConversions?integer

Range0 <= value

minActiveDays?integer

Range0 <= value

Response Body

`application/json`

curl -X POST "https://app.refcampaign.com/api/v1/campaigns" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "landingUrl": "http://example.com",    "commissionRate": 1,    "commissionType": "PERCENTAGE"  }'

Empty

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "string",
    "details": null
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z",
    "requestId": "string"
  }
}

Create a campaign

Authorization

Request Body

Response Body

201

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`