Tracking cancellations

cURL

curl --request POST \
  --url https://firstpromoter.com/api/v1/track/cancellation \
  --header 'X-API-KEY: <api-key>'

{
  "id": 33848911,
  "type": "cancellation",
  "amount_cents": null,
  "reward": null,
  "lead": {
    "id": 20738339,
    "state": "cancelled",
    "email": "[email protected]",
    "uid": null,
    "customer_since": "2024-09-11T14:22:12.160Z",
    "cancelled_at": "2024-09-11T15:07:46.174Z",
    "plan_name": null,
    "suspicion": "no_suspicion",
    "username": null,
    "website": null,
    "created_at": "2024-09-09T16:22:44.168Z",
    "split_promotion_id": null,
    "custom_fields": null,
    "split_percentage_value": null,
    "visitor_sub_id": null
  },
  "promoter": {
    "id": 3920164,
    "status": "active",
    "cust_id": "",
    "email": "[email protected]",
    "created_at": "2022-04-26T15:28:24.800Z",
    "temp_password": "xxxxxxxxxx",
    "default_promotion_id": 4210919,
    "pref": "db1znwe",
    "default_ref_id": "8yi2epelut",
    "note": "This is a note",
    "w8_form_url": null,
    "w9_form_url": null,
    "parent_promoter_id": 577918,
    "earnings_balance": {
      "cash": 50744
    },
    "current_balance": {
      "cash": 20044
    },
    "paid_balance": {
      "cash": 30700
    },
    "auth_token": "xxxxxxxxxxxxxx"
  }
}

POST

cancellation

cURL

curl --request POST \
  --url https://firstpromoter.com/api/v1/track/cancellation \
  --header 'X-API-KEY: <api-key>'

{
  "id": 33848911,
  "type": "cancellation",
  "amount_cents": null,
  "reward": null,
  "lead": {
    "id": 20738339,
    "state": "cancelled",
    "email": "[email protected]",
    "uid": null,
    "customer_since": "2024-09-11T14:22:12.160Z",
    "cancelled_at": "2024-09-11T15:07:46.174Z",
    "plan_name": null,
    "suspicion": "no_suspicion",
    "username": null,
    "website": null,
    "created_at": "2024-09-09T16:22:44.168Z",
    "split_promotion_id": null,
    "custom_fields": null,
    "split_percentage_value": null,
    "visitor_sub_id": null
  },
  "promoter": {
    "id": 3920164,
    "status": "active",
    "cust_id": "",
    "email": "[email protected]",
    "created_at": "2022-04-26T15:28:24.800Z",
    "temp_password": "xxxxxxxxxx",
    "default_promotion_id": 4210919,
    "pref": "db1znwe",
    "default_ref_id": "8yi2epelut",
    "note": "This is a note",
    "w8_form_url": null,
    "w9_form_url": null,
    "parent_promoter_id": 577918,
    "earnings_balance": {
      "cash": 50744
    },
    "current_balance": {
      "cash": 20044
    },
    "paid_balance": {
      "cash": 30700
    },
    "auth_token": "xxxxxxxxxxxxxx"
  }
}

Authorizations

X-API-KEY

string

header

required

Query Parameters

string

required if uid is null

Email of the lead/sign-up

uid

string

required if email is null

uid of the lead added on signup tracking

Response

Success response

integer

Example:

33848911

type

string

Example:

"cancellation"

amount_cents

integer | null

Example:

null

reward

object

Example:

null

lead

object

Show child attributes

lead.id

integer

Example:

20738339

lead.state

string

Example:

"cancelled"

lead.email

string

Example:

"[email protected]"

lead.uid

string | null

Example:

null

lead.customer_since

string<date-time>

Example:

"2024-09-11T14:22:12.160Z"

lead.cancelled_at

string<date-time>

Example:

"2024-09-11T15:07:46.174Z"

lead.plan_name

string | null

Example:

null

lead.suspicion

string

Example:

"no_suspicion"

lead.username

string | null

Example:

null

lead.website

string | null

Example:

null

lead.created_at

string<date-time>

Example:

"2024-09-09T16:22:44.168Z"

lead.split_promotion_id

string | null

Example:

null

lead.custom_fields

string | null

Example:

null

lead.split_percentage_value

string | null

Example:

null

lead.visitor_sub_id

string | null

Example:

null

promoter

object

Show child attributes

promoter.id

integer

ID of the promoter

Example:

3920164

promoter.status

string

Status of the promoter

Example:

"active"

promoter.cust_id

string

Example:

""

promoter.email

string

Email of the promoter

Example:

"[email protected]"

promoter.created_at

string<date-time>

ISO date of when the promoter was created

Example:

"2022-04-26T15:28:24.800Z"

promoter.temp_password

string | null

Temporary password created for the promoter

Example:

"xxxxxxxxxx"

promoter.default_promotion_id

integer

Example:

4210919

promoter.pref

string

Example:

"db1znwe"

promoter.default_ref_id

string

Default referral id of the promoter

Example:

"8yi2epelut"

promoter.note

string | null

A note/description of promoter

Example:

"This is a note"

promoter.w8_form_url

string | null

Url of the w8 form

Example:

null

promoter.w9_form_url

string | null

Url of the w9 form

Example:

null

promoter.parent_promoter_id

integer

Parent promoter id

Example:

577918

promoter.earnings_balance

object

Earning balance of the promoter

Show child attributes

promoter.earnings_balance.cash

integer

Example:

50744

promoter.current_balance

object

Current balance of the promoter

Show child attributes

promoter.current_balance.cash

integer

Example:

20044

promoter.paid_balance

object

Paid balance of the promoter

Show child attributes

promoter.paid_balance.cash

integer

Example:

30700

promoter.auth_token

string

Authentication token generated when the promoter was created

Example:

"xxxxxxxxxxxxxx"

Tracking refunds and negative commissions Modify existing lead/customer

⌘I

API Documentation

Tracking

Leads

Promoters

Rewards

Payouts

Reports

Authorizations

Query Parameters

Response