RefCampaign/docs
Référence APICampaigns

Delete a campaign

Soft-deletes a campaign by id. Active campaigns may need to be paused first depending on plan rules.

DELETE
/api/v1/campaigns/{id}

Soft-deletes a campaign by id. Active campaigns may need to be paused first depending on plan rules.

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

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://app.refcampaign.com/api/v1/campaigns/string"
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"
  }
}

Get a campaign GET

Returns a single campaign by id.

Update a campaign PUT

Updates a campaign by id. 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.