Sign in

v1

latestOpenAPI 3.0.02026-07-264731126.7 KB
Promoters

Update promoter

With this endpoint you can update a promoter. <Tip>HTTP Request <br/>PUT https://api.firstpromoter.com/api/v2/company/promoters/{id}</Tip>

put/promoters/{id}

Path parameters

idinteger required

Id of the promoter

Headers

Account-IDstring required

Account id. You can find your Account ID on Your FirstPromoter Dashboard. Navigate to Settings → Integrations

Request body

emailstring email

Email address of the promoter

find_by'email' | 'cust_id' | 'auth_token' | 'ref_token' | 'promo_code'

Find by attribute. Required when you want to find the promoter using another parameter like the email, cust_id, auth_token, ref_token, or promo_code instead of an ID.

Your request should follow the format https://api.firstpromoter.com/api/v2/company/promoters/{email, cust_id, auth_token, ref_token, or promo_code}

cust_idstring nullable

Cust ID of the promoter

profile[_destroy_w8form]boolean

Destroy W8 form

profile[_destroy_w9form]boolean

Destroy W9 form

Example request

{
  "profile": {
    "country": "US"
  }
}

Response

Promoter updated successfully

idinteger

ID of the promoter

statusstring

Status of the promoter

cust_idstring
emailstring

Email of the promoter

created_atstring date-time

ISO date of when the promoter was created

temp_passwordstring nullable

Temporary password created for the promoter

default_promotion_idinteger
prefstring
default_ref_idstring

Default referral id of the promoter

notestring nullable

A note/description of promoter

w8_form_urlstring nullable

Url of the w8 form

w9_form_urlstring nullable

Url of the w9 form

parent_promoter_idinteger

Parent promoter id

auth_tokenstring

Authentication token generated when the promoter was created

Example response

{
  "id": 3920164,
  "status": "active",
  "email": "peluwydo@mailinator.com",
  "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",
  "parent_promoter_id": 577918,
  "earnings_balance": {
    "cash": 50744
  },
  "current_balance": {
    "cash": 20044
  },
  "paid_balance": {
    "cash": 30700
  },
  "auth_token": "xxxxxxxxxxxxxx"
}