Promoter Accepted


{
"event": {
  "id": 22733469,
  "type": "promoter_accepted",
  "created_at": "2024-10-03T11:57:31.228Z"
},
"data": {
  "state": "accepted",
  "campaign": {
    "id": 13202,
    "name": "Jaquelyn Ryan",
    "landing_url": "https://www.cax.ws",
    "description": "",
    "private": false,
    "color": "#42a5f5",
    "default_webhook_url": "https://h.albato.com/wh/38/1lfiorr/DQRARvqv1zQQuxMO4FKsgWJ66qVqwm9HcfvTqCqdfF0/",
    "auto_approve_rewards": true,
    "auto_approve_promoters": false,
    "offer": {
      "id": 67212,
      "name": "5% discount coupon",
      "amount": 5,
      "unit": "discount_per",
      "default_promo_code": " MAXADA-5"
    },
    "referral_reward": {
      "id": 128312,
      "amount": 0,
      "type": "per_referral",
      "unit": "cash",
      "name": "20% recurring commission",
      "per_of_sale": 20,
      "default_promo_code": ""
    },
    "promotion_reward": {
      "id": 68347,
      "amount": null,
      "type": "per_promotion",
      "unit": "free_months",
      "name": "Free subscription months",
      "per_of_sale": 0,
      "default_promo_code": null
    },
    "target_reward": null
  },
  "promoter": {
    "id": 9000754,
    "status": "active",
    "cust_id": null,
    "email": "[email protected]",
    "created_at": "2024-10-03T11:57:30.943Z",
    "temp_password": "VKD-uS",
    "default_promotion_id": 11027468,
    "pref": "bh4oj6x",
    "default_ref_id": "bhyrr",
    "note": null,
    "w8_form_url": null,
    "w9_form_url": null,
    "parent_promoter_id": null,
    "earnings_balance": null,
    "current_balance": null,
    "paid_balance": null,
    "auth_token": "nu9NhM6Hza-kybjZZJivC-FgMtxMrT_o",
    "profile": {
      "id": 9048173,
      "first_name": "Cooper",
      "last_name": "Faulkner",
      "website": "https://www.baxyzozocu.org.au",
      "company_name": "Dalton and Mcneil",
      "phone_number": null,
      "address": "",
      "vat_id": "",
      "country": "AU",
      "paypal_email": null,
      "avatar_url": null,
      "description": null,
      "social_accounts": {
        "tiktok": {
          "url": ""
        },
        "twitch": {
          "url": ""
        },
        "twitter": {
          "url": ""
        },
        "youtube": {
          "url": ""
        },
        "facebook": {
          "url": ""
        },
        "linkedin": {
          "url": ""
        },
        "instagram": {
          "url": ""
        }
      }
    },
    "promotions": [
      {
        "id": 11027468,
        "status": "offer_running",
        "ref_id": "bhyrr",
        "promo_code": null,
        "customer_promo_code": null,
        "target_reached_at": null,
        "promoter_id": 9000754,
        "campaign_id": 13202,
        "referral_link": "https://www.cax.ws?_get=bhyrr",
        "current_offer": {
          "id": 67212,
          "name": "5% discount coupon",
          "amount": 5,
          "unit": "discount_per",
          "default_promo_code": " MAXADA-5"
        },
        "current_referral_reward": {
          "id": 128312,
          "amount": 0,
          "type": "per_referral",
          "unit": "cash",
          "name": "20% recurring commission",
          "per_of_sale": 20,
          "default_promo_code": ""
        },
        "current_promotion_reward": {
          "id": 68347,
          "amount": null,
          "type": "per_promotion",
          "unit": "free_months",
          "name": "Free subscription months",
          "per_of_sale": 0,
          "default_promo_code": null
        },
        "current_target_reward": null,
        "campaign_name": "Jaquelyn Ryan",
        "hidden": false,
        "visitors_count": 0,
        "leads_count": 0,
        "customers_count": 0,
        "refunds_count": 0,
        "cancellations_count": 0,
        "sales_count": 0,
        "sales_total": 0,
        "refunds_total": 0,
        "active_customers_count": 0
      }
    ]
  },
  "promotion": {
    "id": 11027468,
    "status": "offer_running",
    "ref_id": "bhyrr",
    "promo_code": null,
    "customer_promo_code": null,
    "target_reached_at": null,
    "promoter_id": 9000754,
    "campaign_id": 13202,
    "referral_link": "https://www.cax.ws?_get=bhyrr",
    "current_offer": {
      "id": 67212,
      "name": "5% discount coupon",
      "amount": 5,
      "unit": "discount_per",
      "default_promo_code": " MAXADA-5"
    },
    "current_referral_reward": {
      "id": 128312,
      "amount": 0,
      "type": "per_referral",
      "unit": "cash",
      "name": "20% recurring commission",
      "per_of_sale": 20,
      "default_promo_code": ""
    },
    "current_promotion_reward": {
      "id": 68347,
      "amount": null,
      "type": "per_promotion",
      "unit": "free_months",
      "name": "Free subscription months",
      "per_of_sale": 0,
      "default_promo_code": null
    },
    "current_target_reward": null,
    "campaign_name": "Jaquelyn Ryan",
    "hidden": false,
    "visitors_count": 0,
    "leads_count": 0,
    "customers_count": 0,
    "refunds_count": 0,
    "cancellations_count": 0,
    "sales_count": 0,
    "sales_total": 0,
    "refunds_total": 0,
    "active_customers_count": 0
  }
}
}


{
"event": {
  "id": 22733469,
  "type": "promoter_accepted",
  "created_at": "2024-10-03T11:57:31.228Z"
},
"data": {
  "state": "accepted",
  "campaign": {
    "id": 13202,
    "name": "Jaquelyn Ryan",
    "landing_url": "https://www.cax.ws",
    "description": "",
    "private": false,
    "color": "#42a5f5",
    "default_webhook_url": "https://h.albato.com/wh/38/1lfiorr/DQRARvqv1zQQuxMO4FKsgWJ66qVqwm9HcfvTqCqdfF0/",
    "auto_approve_rewards": true,
    "auto_approve_promoters": false,
    "offer": {
      "id": 67212,
      "name": "5% discount coupon",
      "amount": 5,
      "unit": "discount_per",
      "default_promo_code": " MAXADA-5"
    },
    "referral_reward": {
      "id": 128312,
      "amount": 0,
      "type": "per_referral",
      "unit": "cash",
      "name": "20% recurring commission",
      "per_of_sale": 20,
      "default_promo_code": ""
    },
    "promotion_reward": {
      "id": 68347,
      "amount": null,
      "type": "per_promotion",
      "unit": "free_months",
      "name": "Free subscription months",
      "per_of_sale": 0,
      "default_promo_code": null
    },
    "target_reward": null
  },
  "promoter": {
    "id": 9000754,
    "status": "active",
    "cust_id": null,
    "email": "[email protected]",
    "created_at": "2024-10-03T11:57:30.943Z",
    "temp_password": "VKD-uS",
    "default_promotion_id": 11027468,
    "pref": "bh4oj6x",
    "default_ref_id": "bhyrr",
    "note": null,
    "w8_form_url": null,
    "w9_form_url": null,
    "parent_promoter_id": null,
    "earnings_balance": null,
    "current_balance": null,
    "paid_balance": null,
    "auth_token": "nu9NhM6Hza-kybjZZJivC-FgMtxMrT_o",
    "profile": {
      "id": 9048173,
      "first_name": "Cooper",
      "last_name": "Faulkner",
      "website": "https://www.baxyzozocu.org.au",
      "company_name": "Dalton and Mcneil",
      "phone_number": null,
      "address": "",
      "vat_id": "",
      "country": "AU",
      "paypal_email": null,
      "avatar_url": null,
      "description": null,
      "social_accounts": {
        "tiktok": {
          "url": ""
        },
        "twitch": {
          "url": ""
        },
        "twitter": {
          "url": ""
        },
        "youtube": {
          "url": ""
        },
        "facebook": {
          "url": ""
        },
        "linkedin": {
          "url": ""
        },
        "instagram": {
          "url": ""
        }
      }
    },
    "promotions": [
      {
        "id": 11027468,
        "status": "offer_running",
        "ref_id": "bhyrr",
        "promo_code": null,
        "customer_promo_code": null,
        "target_reached_at": null,
        "promoter_id": 9000754,
        "campaign_id": 13202,
        "referral_link": "https://www.cax.ws?_get=bhyrr",
        "current_offer": {
          "id": 67212,
          "name": "5% discount coupon",
          "amount": 5,
          "unit": "discount_per",
          "default_promo_code": " MAXADA-5"
        },
        "current_referral_reward": {
          "id": 128312,
          "amount": 0,
          "type": "per_referral",
          "unit": "cash",
          "name": "20% recurring commission",
          "per_of_sale": 20,
          "default_promo_code": ""
        },
        "current_promotion_reward": {
          "id": 68347,
          "amount": null,
          "type": "per_promotion",
          "unit": "free_months",
          "name": "Free subscription months",
          "per_of_sale": 0,
          "default_promo_code": null
        },
        "current_target_reward": null,
        "campaign_name": "Jaquelyn Ryan",
        "hidden": false,
        "visitors_count": 0,
        "leads_count": 0,
        "customers_count": 0,
        "refunds_count": 0,
        "cancellations_count": 0,
        "sales_count": 0,
        "sales_total": 0,
        "refunds_total": 0,
        "active_customers_count": 0
      }
    ]
  },
  "promotion": {
    "id": 11027468,
    "status": "offer_running",
    "ref_id": "bhyrr",
    "promo_code": null,
    "customer_promo_code": null,
    "target_reached_at": null,
    "promoter_id": 9000754,
    "campaign_id": 13202,
    "referral_link": "https://www.cax.ws?_get=bhyrr",
    "current_offer": {
      "id": 67212,
      "name": "5% discount coupon",
      "amount": 5,
      "unit": "discount_per",
      "default_promo_code": " MAXADA-5"
    },
    "current_referral_reward": {
      "id": 128312,
      "amount": 0,
      "type": "per_referral",
      "unit": "cash",
      "name": "20% recurring commission",
      "per_of_sale": 20,
      "default_promo_code": ""
    },
    "current_promotion_reward": {
      "id": 68347,
      "amount": null,
      "type": "per_promotion",
      "unit": "free_months",
      "name": "Free subscription months",
      "per_of_sale": 0,
      "default_promo_code": null
    },
    "current_target_reward": null,
    "campaign_name": "Jaquelyn Ryan",
    "hidden": false,
    "visitors_count": 0,
    "leads_count": 0,
    "customers_count": 0,
    "refunds_count": 0,
    "cancellations_count": 0,
    "sales_count": 0,
    "sales_total": 0,
    "refunds_total": 0,
    "active_customers_count": 0
  }
}
}

By setting up a webhook, your endpoint will receive an event when a promoter is created.

Response Paramerters

Event

Event Object

Show properties

string

The Id of the event

type

string

Indicates the webhook event type, such as promoter_accepted.

created_at

string

Timestamp of when the event occurred.

Data

Data Object

Show properties

state

string

Current state of the promoter in relation to the campaign (e.g., “accepted”).

campaign

Campaign Object

Show properties

number

The Id of the campaign

name

string

The name of the campaign

landing_url

string

The landing url of the campaign

description

string

The description of the campaign

private

boolean

Whether the campaign is private

color

string

The color of the campaign

default_webhook_url

string

The default webhook url of the campaign

auto_approve_rewards

boolean

Whether the campaign automatically approves rewards

auto_approve_promoters

boolean

Whether the campaign automatically approves promoters

offer

Offer Object

Show properties

number

The Id of the offer

name

string

The name of the offer

amount

number

The amount of the offer

unit

string

The unit of the offer

The default promo code of the offer

referral_reward

Referral Reward Object

Show properties

number

The Id of the referral reward

amount

number

The amount of the referral reward

type

string

The type of the referral reward

unit

string

The unit of the referral reward

name

string

The name of the referral reward

per_of_sale

number

The per of sale of the referral reward

The default promo code of the referral reward

promotion_reward

Promotion Reward Object

Show properties

number

The Id of the promotion reward

amount

number

The amount of the promotion reward

type

string

The type of the promotion reward

unit

string

The unit of the promotion reward

name

string

The name of the promotion reward

per_of_sale

number

The per of sale of the promotion reward

The default promo code of the promotion reward

target_reward

string

The target reward of the campaign

promoter

Promoter Object

Show properties

number

The Id of the promoter

status

string

The status of the promoter

cust_id

string

The customer id of the promoter

string

The email of the promoter

created_at

string

The date the promoter was created

temp_password

string

The temporary password of the promoter

default_promotion_id

number

The default promotion id of the promoter

pref

string

The pref of the promoter

default_ref_id

string

The default referral id of the promoter

note

string

The note saved on the promoter profile by an admin

w8_form_url

string

The w8 form url saved on the promoter profile by an admin

w9_form_url

string

The w9 form url saved on the promoter profile by an admin

parent_promoter_id

number

The parent promoter id of the promoter

earnings_balance

number

The earnings balance of the promoter

current_balance

number

The current balance of the promoter

paid_balance

number

The paid balance of the promoter

auth_token

string

The auth token of the promoter

profile

Profile Object

Show properties

number

The Id of the profile

first_name

string

The first name of the profile

last_name

string

The last name of the profile

website

string

The website of the profile

company_name

string

The company name of the profile

phone_number

string

The phone number of the profile

address

string

The address of the profile

vat_id

string

The vat id of the profile

country

string

The country of the profile

paypal_email

string

The paypal email of the profile

avatar_url

string

The avatar url of the profile

description

string

The description of the profile

Show properties

tiktok

Social Account Object

Show properties

url

string

The url of the social account

twitch

Social Account Object

Show properties

url

string

The url of the social account

twitter

Social Account Object

Show properties

url

string

The url of the social account

youtube

Social Account Object

Show properties

url

string

The url of the social account

facebook

Social Account Object

Show properties

url

string

The url of the social account

Social Account Object

Show properties

url

string

The url of the social account

instagram

Social Account Object

Show properties

url

string

The url of the social account

promotions

Promotions Array

Show properties

promotion

Promotion Object

Show properties

number

The Id of the promotion

status

string

The status of the promotion

ref_id

string

The referral id of the promotion

The promo code of the promotion

The customer promo code of the promotion

target_reached_at

string

The target reached at of the promotion

promoter_id

number

The promoter id of the promotion

campaign_id

number

The campaign id of the promotion

referral_link

string

The referral link of the promotion

current_offer

Offer Object

Show properties

number

The Id of the offer

name

string

The name of the offer

amount

number

The amount of the offer

unit

string

The unit of the offer

The default promo code of the offer

current_referral_reward

Current referral reward Object

Show properties

number

The Id of the referral reward

amount

number

The amount of the referral reward

type

string

The type of the referral reward

unit

string

The unit of the referral reward

name

string

The name of the referral reward

per_of_sale

number

The per of sale of the referral reward

The default promo code of the referral reward

current_promotion_reward

Current promotion reward Object

Show properties

number

The Id of the promotion reward

amount

number

The amount of the promotion reward

type

string

The type of the promotion reward

unit

string

The unit of the promotion reward

name

string

The name of the promotion reward

per_of_sale

number

The per of sale of the promotion reward

The default promo code of the promotion reward

current_target_reward

Current target reward Object

Show properties

number

The Id of the referral reward

amount

number

The amount of the referral reward

type

string

The type of the referral reward

unit

string

The unit of the referral reward

name

string

The name of the referral reward

per_of_sale

number

The per of sale of the referral reward

The default promo code of the referral reward

campaign_name

string

The name of the campaign

hidden

boolean

Whether the campaign is hidden

visitors_count

number

The number of visitors

leads_count

number

The number of leads

customers_count

number

The number of customers

refunds_count

number

The number of refunds

cancellations_count

number

The number of cancellations

sales_count

number

The number of sales

sales_total

number

The total sales

refunds_total

number

The total refunds

active_customers_count

number

The number of active customers


{
"event": {
  "id": 22733469,
  "type": "promoter_accepted",
  "created_at": "2024-10-03T11:57:31.228Z"
},
"data": {
  "state": "accepted",
  "campaign": {
    "id": 13202,
    "name": "Jaquelyn Ryan",
    "landing_url": "https://www.cax.ws",
    "description": "",
    "private": false,
    "color": "#42a5f5",
    "default_webhook_url": "https://h.albato.com/wh/38/1lfiorr/DQRARvqv1zQQuxMO4FKsgWJ66qVqwm9HcfvTqCqdfF0/",
    "auto_approve_rewards": true,
    "auto_approve_promoters": false,
    "offer": {
      "id": 67212,
      "name": "5% discount coupon",
      "amount": 5,
      "unit": "discount_per",
      "default_promo_code": " MAXADA-5"
    },
    "referral_reward": {
      "id": 128312,
      "amount": 0,
      "type": "per_referral",
      "unit": "cash",
      "name": "20% recurring commission",
      "per_of_sale": 20,
      "default_promo_code": ""
    },
    "promotion_reward": {
      "id": 68347,
      "amount": null,
      "type": "per_promotion",
      "unit": "free_months",
      "name": "Free subscription months",
      "per_of_sale": 0,
      "default_promo_code": null
    },
    "target_reward": null
  },
  "promoter": {
    "id": 9000754,
    "status": "active",
    "cust_id": null,
    "email": "[email protected]",
    "created_at": "2024-10-03T11:57:30.943Z",
    "temp_password": "VKD-uS",
    "default_promotion_id": 11027468,
    "pref": "bh4oj6x",
    "default_ref_id": "bhyrr",
    "note": null,
    "w8_form_url": null,
    "w9_form_url": null,
    "parent_promoter_id": null,
    "earnings_balance": null,
    "current_balance": null,
    "paid_balance": null,
    "auth_token": "nu9NhM6Hza-kybjZZJivC-FgMtxMrT_o",
    "profile": {
      "id": 9048173,
      "first_name": "Cooper",
      "last_name": "Faulkner",
      "website": "https://www.baxyzozocu.org.au",
      "company_name": "Dalton and Mcneil",
      "phone_number": null,
      "address": "",
      "vat_id": "",
      "country": "AU",
      "paypal_email": null,
      "avatar_url": null,
      "description": null,
      "social_accounts": {
        "tiktok": {
          "url": ""
        },
        "twitch": {
          "url": ""
        },
        "twitter": {
          "url": ""
        },
        "youtube": {
          "url": ""
        },
        "facebook": {
          "url": ""
        },
        "linkedin": {
          "url": ""
        },
        "instagram": {
          "url": ""
        }
      }
    },
    "promotions": [
      {
        "id": 11027468,
        "status": "offer_running",
        "ref_id": "bhyrr",
        "promo_code": null,
        "customer_promo_code": null,
        "target_reached_at": null,
        "promoter_id": 9000754,
        "campaign_id": 13202,
        "referral_link": "https://www.cax.ws?_get=bhyrr",
        "current_offer": {
          "id": 67212,
          "name": "5% discount coupon",
          "amount": 5,
          "unit": "discount_per",
          "default_promo_code": " MAXADA-5"
        },
        "current_referral_reward": {
          "id": 128312,
          "amount": 0,
          "type": "per_referral",
          "unit": "cash",
          "name": "20% recurring commission",
          "per_of_sale": 20,
          "default_promo_code": ""
        },
        "current_promotion_reward": {
          "id": 68347,
          "amount": null,
          "type": "per_promotion",
          "unit": "free_months",
          "name": "Free subscription months",
          "per_of_sale": 0,
          "default_promo_code": null
        },
        "current_target_reward": null,
        "campaign_name": "Jaquelyn Ryan",
        "hidden": false,
        "visitors_count": 0,
        "leads_count": 0,
        "customers_count": 0,
        "refunds_count": 0,
        "cancellations_count": 0,
        "sales_count": 0,
        "sales_total": 0,
        "refunds_total": 0,
        "active_customers_count": 0
      }
    ]
  },
  "promotion": {
    "id": 11027468,
    "status": "offer_running",
    "ref_id": "bhyrr",
    "promo_code": null,
    "customer_promo_code": null,
    "target_reached_at": null,
    "promoter_id": 9000754,
    "campaign_id": 13202,
    "referral_link": "https://www.cax.ws?_get=bhyrr",
    "current_offer": {
      "id": 67212,
      "name": "5% discount coupon",
      "amount": 5,
      "unit": "discount_per",
      "default_promo_code": " MAXADA-5"
    },
    "current_referral_reward": {
      "id": 128312,
      "amount": 0,
      "type": "per_referral",
      "unit": "cash",
      "name": "20% recurring commission",
      "per_of_sale": 20,
      "default_promo_code": ""
    },
    "current_promotion_reward": {
      "id": 68347,
      "amount": null,
      "type": "per_promotion",
      "unit": "free_months",
      "name": "Free subscription months",
      "per_of_sale": 0,
      "default_promo_code": null
    },
    "current_target_reward": null,
    "campaign_name": "Jaquelyn Ryan",
    "hidden": false,
    "visitors_count": 0,
    "leads_count": 0,
    "customers_count": 0,
    "refunds_count": 0,
    "cancellations_count": 0,
    "sales_count": 0,
    "sales_total": 0,
    "refunds_total": 0,
    "active_customers_count": 0
  }
}
}

New Customer Fulfilment Pending

Overview

How to Guides

Scripts

Integration Options

Webhooks

Response Paramerters

Overview

How to Guides

Scripts

Integration Options

Webhooks

​Response Paramerters

Response Paramerters