POST
/
create

Use this endpoint to create new promoters using the API. The response will return the newly added promoter as JSON.

Probably the most important value from the response is “auth_token”, which is a unique key auto-generated on creation and can be used to automatically log in your promoters to their dashboard. Learn more

If this call is successful and you enabled “Promoter sign up accepted” emails for the campaign, it will start sending emails to the promoter. To skip the emails, set the skip_email_notification parameter to “true”.

Authorizations

X-API-KEY
string
headerrequired

Query Parameters

email
string
required

Promoter's email

first_name
string

Promoter's first name

last_name
string

Promoter's last name

cust_id
string

Your customer's user ID inside your application/system for the promoter. It will be avaliable in the webhooks to identify the promoter in your system if you subscribe for FirstPromoter webhooks.

ref_id
string

Referral ID. If this is blank an ID is assigned based on the first name. Can be only lower-case letters , numbers , -(hyphen) and _(underscore)

promo_code
string

Unique promo code from your billing provider to assign to this affiliate for coupon tracking. This is also known as the Coupon Code or Coupon ID

customer_promo_code
string

Customer promo code from your billing provider to assign to this affiliate for coupon tracking. This is also known as discount code or promotion code or display code. This is the code your customer(s) can use on the checkout form/page.

campaign_id
string

The ID of the campaign to assign the promoter to. On the campaigns sections you can see the id as camp_id query parameter on 'Promoter Sign Up page URL'. If there is no camp_id it means the campaign is the default campaign and this parameter is not required.

temp_password
string

A temporary password promoters can use to log in to their dashboard if you don't use authentication tokens(auth_token) to sign promoters in automatically.

landing_url
string

You can set up a custom landing page url for this promoter. The referral id will be appended to it, unless the url_tracking parameter(below) is used.

url_tracking
string

Set true to enable direct url tracking feature. FirstPromoter will do the tracking based on landing_url(above) without requiring the referral id to be appended to the url. The landing_url needs to be unique for each promoter. Default is false.

website
string

Promoter's website

paypal_email
string

Promoter's Paypal email address

avatar_url
string

URL of the profile picture promoters can see on their dashboard

parent_promoter_id
string

Id of the parent if the promoter is a sub-affiliate

parent_promoter_email
string

Email of the parent promoter if the promoter is a sub-affiliate

linkedin_url
string

Promoter's linkedin url

twitter_url
string

Promoter's twitter url

facebook_url
string

Promoter's facebook url

instagram_url
string

Promoter's instagram url

youtube_url
string

Promoter's youtube url

country
string

Promoter's country

company_name
string

Promoter's company name

phone_number
string

Promoter's phone number

address
string

Promoter's address

note
string

A note/description of promoter

created_at
string

ISO date string of the date of the signup event

skip_email_notification
boolean

Set this to true to skip email notifications. Default is false.

Response

200 - application/json
id
integer

The promoter's ID inside FirstPromoter

status
enum<string>

Promoter's status

Available options:
approved,
pending,
denied
cust_id
string

Your customer's user ID inside your application/system for the promoter. This will be included in the webhook event and can be used to identify the promoter in your system if you scribscibe for FirstPromoter's webhooks.

email
string

Promoter's email

created_at
string

ISO date string when the promoter signed up

temp_password
string

A temporary password the promoter can use to log in to their dashboard if you don't use authentication tokens(auth_token) to sign promoters in automatically.

default_promotion_id
number

Promoter's default promotion id

pref
string

Promoter's parent referral id.

default_ref_id
string

Promoter's default referral id

note
string

A note/description of promoter

w8_form_url
string

The w8 form url

w9_form_url
string

The w9 form url

parent_promoter_id
string

Parent promoter id

earnings_balance
object

Promoter's earnings balance. This object can contain cash, credits, discount_per

current_balance
object

Promoter's current balance. This object can contain cash, credits, discount_per

paid_balance
object

Promoter's paid balance. This object can contain cash, credits, discount_per

auth_token
string

Authentication token generated when the promoter was created

profile
object
promotions
object[]
Delete lead/customerModify existing promoter