PUT
/
update

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
cancelled_at
string

ISO date string at which the lead/customer cancelled

created_at
string

ISO date string at which the lead/customer signed up

custom_fields
any
customer_since
string

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

email
string

The lead's or customer's email

id
integer

The lead's ID inside FirstPromoter

plan_name
string
promoter
object
promotion
object
split_percentage_value
any
split_promotion_id
any
status
enum<string>

The lead's or customer's status

Available options:
signup,
active,
subscribed,
denied,
cancelled
suspicion
string
uid
any

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

username
string
visitor_sub_id
any
website
string