New Affiliate

post

https://api.refersion.com/v2/affiliate/new

Create a new affiliate. Returns the affiliate ID and their referral link.

Tip: When creating affilates using this endpoint, we recommend that you save the id from the response in order to map your user to their affiliate account in Refersion.

Body Params

If you want to send custom fields, please contact us for detailed instructions.

offer

string

Defaults to 12345

Specific Offer ID to opt affiliate into, otherwise your default offer is used.

first_name

string

required

Defaults to Bill

The affiliate's first name.

last_name

string

required

Defaults to Smith

The affiliate's last name

string

required

Defaults to [email protected]

Must be a valid email.

password

string

required

Defaults to testing

Has at least 9 characters. The password is NOT more than 72 characters. Has at least 1 upper case character. Has at least 1 lower case character. Has at least 1 numerical character. Has at least 1 special character. Does NOT have the same character repeated more than 3 times in a row. Password does NOT match the email of the user.

company

string

paypal_email

string

address1

string

address2

string

city

string

zip

string

country

string

length between 2 and 2

Country Code (two letter abbreviation) must match one of: US, AE, AR, AS, AT, AU, BA, BD, BE, BG, BR, CA, CH, CL, CN, CO, CR, CZ, DE, DK, DZ, EE, ES, FI, FM, FO, FR, GB, GH, GR, GU, HK, HN, HR, HU, ID, IE, IL, IM, IN, IS, IT, JM, JP, KR, KW, LT, LU, LV, MA, MH, MK, MP, MT, MX, MY, NG, NL, NO, NZ, OM, PE, PH, PK, PL, PR, PT, PW, QA, RO, RS, RU, SA, SE, SG, SI, SK, SV, TH, TN, TR, TW, TZ, UA, UY, VG, VI, VN, WS, ZA

state

string

phone

string

send_welcome

string

enum

Defaults to FALSE

Should Refersion send our welcome email? Options: TRUE / FALSE; Default = FALSE

Allowed:

status

string

enum

required

Defaults to PENDING

What status should the affiliate be created as: PENDING or ACTIVE?

Allowed:

conversion_trigger_coupon

string

Defaults to BILLSMITH10

A unique coupon code to assign to this affiliate as a conversion trigger.

unique_merchant_id

string

Defaults to abc123

An optional alphanumeric identifier for the affiliate for your team's internal use.

Headers

Refersion-Public-Key

string

Refersion-Secret-Key

string

Content-Type

string

enum

Defaults to application/json

Allowed:

Responses

200

204Theres an invalid field in the request

400Theres a missing required field in your request.

401Unauthorized – Your API keys are incorrect.

404An empty request body.

422Unprocessable Entity – The data that you’re sending has errors.