PUT
/
update
curl --request PUT \
  --url https://firstpromoter.com/api/v1/leads/update \
  --header 'X-API-KEY: <api-key>'
{
  "id": 123,
  "status": "signup",
  "uid": "<any>",
  "email": "jsmith@example.com",
  "customer_since": "<string>",
  "cancelled_at": "<string>",
  "plan_name": "<string>",
  "suspicion": "<string>",
  "username": "<string>",
  "website": "<string>",
  "created_at": "<string>",
  "split_promotion_id": "<any>",
  "custom_fields": "<any>",
  "split_percentage_value": "<any>",
  "visitor_sub_id": "<any>",
  "promotion": {
    "id": 123,
    "status": "<string>",
    "ref_id": "<string>",
    "promo_code": "<string>",
    "customer_promo_code": "<string>",
    "target_reached_at": "<string>",
    "promoter_id": 123,
    "campaign_id": 123,
    "referral_link": "<string>",
    "current_offer": {
      "id": 123,
      "name": "<string>",
      "amount": 123,
      "unit": "<string>",
      "default_promo_code": "<string>"
    },
    "current_referral_reward": {
      "id": 123,
      "amount": 123,
      "unit": "<string>",
      "name": "<string>",
      "per_of_sale": 123,
      "default_promo_code": "<string>"
    },
    "current_promotion_reward": {},
    "current_target_reward": {},
    "campaign_name": "<string>",
    "hidden": true,
    "visitors_count": 123,
    "leads_count": 123,
    "customers_count": 123,
    "refunds_count": 123,
    "cancellations_count": 123,
    "sales_count": 123,
    "sales_total": 123,
    "refunds_total": 123,
    "active_customers_count": 123
  },
  "promoter": {
    "id": 123,
    "status": "approved",
    "cust_id": "<any>",
    "email": "<string>",
    "created_at": "<string>",
    "temp_password": "<string>",
    "default_promotion_id": 123,
    "pref": "<string>",
    "default_ref_id": "<string>",
    "note": "<string>",
    "w8_form_url": "<any>",
    "w9_form_url": "<any>",
    "parent_promoter_id": "<string>",
    "earnings_balance": {},
    "current_balance": {},
    "paid_balance": {},
    "auth_token": "<string>"
  }
}

Authorizations

​
X-API-KEY
string
header
required

Query Parameters

​
id
string

required if email or uid is null

ID of the lead or customer

​
uid
string

required if email or id is null

UID of the lead or customer.

​
email
string

required if id and uid is null

Email of the lead or customer.

​
new_uid
string

New uid of the lead or customer.

​
new_email
string

New email of the lead or customer.

​
new_ref_id
string

If you want to move the lead or customer to another promoter, you can enter the referral id of the new promotion

​
state
enum<string>

Lead's state`

Available options:
signup,
active,
subscribed,
denied,
cancelled
​
customer_since
string

ISO datetime when the lead was converted to a customer

​
plan_name
string

Id of the plan the customer was assigned to. Needs to match with the plans set on FirstPromoter

Response

200
application/json
Success response
​
id
integer

The lead's ID inside FirstPromoter

​
status
enum<string>

The lead's or customer's status

Available options:
signup,
active,
subscribed,
denied,
cancelled
​
uid
any

Your lead/customer's user ID inside your application.

​
email
string

The lead's or customer's email

​
customer_since
string

ISO date string at which the lead converted to a customer.

​
cancelled_at
string

ISO date string at which the lead/customer cancelled

​
plan_name
string
​
suspicion
string
​
username
string
​
website
string
​
created_at
string

ISO date string at which the lead/customer signed up

​
split_promotion_id
any
​
custom_fields
any
​
split_percentage_value
any
​
visitor_sub_id
any
​
promotion
object
​
promoter
object