Skip to main content
AffiliatesVersion: v3

Create Affiliate

POST/affiliate-manager/{locationId}/affiliates

Create an affiliate for a location. An affiliate already registered with the same email in this location is updated instead of duplicated.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:affiliate-manager.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

locationIdstringrequired

Location Id

Example:ve9EPM428h8vShlRW1KT

Body

application/json
affiliateFirstNamestring

First Name

Example:John
affiliateLastNamestring

Last Name

Example:Deo
affiliateEmailstringrequired

Email

Example:[email protected]
phoneNumberstring

Phone Number

Example:+1 888 888-8888
websiteUrlstring

Website

Example:https://google.com
campaignIdstring

Campaign to enrol the affiliate into

Example:6385d230f6d19db03eef6fb2
companyNamestring

Company the affiliate represents

Example:Acme Inc
parentAffiliateIdstring

Affiliate this one is a sub affiliate of

Example:63d376de11be1d26d38f7369
tiernumber

Commission tier the affiliate sits on within the campaign

Possible values: >= 1

Example:2
companyPhoneNumberstring

Company Phone Number

Example:+1 888 888-8888
vatIdstring

VAT ID

Example:VAT12345
countrystring

Country

Example:US
addressstring

Address

Example:123 Main St
avatarstring

Avatar URL

Example:https://example.com/avatar.jpg
facebookUrlstring

Facebook URL

Example:https://facebook.com/profile
twitterUrlstring

Twitter URL

Example:https://twitter.com/profile
youtubeUrlstring

YouTube URL

Example:https://youtube.com/channel
linkedInUrlstring

LinkedIn URL

Example:https://linkedin.com/in/profile
instagramUrlstring

Instagram URL

Example:https://instagram.com/profile

Response

application/json

Successful response

_idstringrequired

Affiliate id

Example:63d147176c5bbc30e9e091a4
firstNamestring

Affiliate first name

Example:John
lastNamestring

Affiliate last name

Example:Doe
phonestring

Affiliate phone number

Example:+1 888 888-8888
deletedboolean

Whether the affiliate is deleted

Example:false
locationIdstringrequired

Location id

Example:ve9EPM428h8vShlRW1KT
activeboolean

Whether the affiliate is active

Example:true
addressstring

Affiliate address

Example:123 Main St
avatarstring

Affiliate avatar URL

Example:https://example.com/avatar.png
createdAtstring

Created at timestamp

Example:2024-06-16T00:00:00.000Z
createdByobject

Who created the affiliate

facebookUrlstring

Facebook URL

Example:https://facebook.com/johndoe
instagramUrlstring

Instagram URL

Example:https://instagram.com/johndoe
linkedInUrlstring

LinkedIn URL

Example:https://linkedin.com/in/johndoe
twitterUrlstring

Twitter URL

Example:https://twitter.com/johndoe
youtubeUrlstring

YouTube URL

Example:https://youtube.com/channel
websiteUrlstring

Website URL

Example:https://example.com
contactIdstring

Contact id associated with the affiliate

Example:ve9EPM428h8vShlRW1KT
campaignIdsstring[]

Campaign ids

Example:["650173614761b33c46d33b19"]
vatIdstring

VAT ID

Example:VAT123
updatedAtstring

Updated at timestamp

Example:2024-06-16T00:00:00.000Z
w8Formstring

W-8 form URL

Example:https://example.com/tax-forms/w8.pdf
w9Formstring

W-9 form URL

Example:https://example.com/tax-forms/w9.pdf
lastUpdatedByobject

Who last updated the affiliate

emailstringrequired

Affiliate email

Example:[email protected]
revenuenumber

Affiliate revenue

Example:1250.5
companyNamestring

Company name

Example:Doe Media LLC
companyPhoneNumberstring

Company phone number

Example:+1 888 888-8888
countrystring

Country the affiliate was created with

Example:US
commissionTiernumber

Commission tier the affiliate sits in

Example:1