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.

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

Location Id

application/json

application/json

Body

Bodyrequired

affiliateFirstNamestring

First Name

affiliateLastNamestring

Last Name

affiliateEmailstringrequired

Email

phoneNumberstring

Phone Number

websiteUrlstring

Website

campaignIdstring

Campaign to enrol the affiliate into

companyNamestring

Company the affiliate represents

parentAffiliateIdstring

Affiliate this one is a sub affiliate of

tiernumber

Commission tier the affiliate sits on within the campaign

Possible values: >= 1

companyPhoneNumberstring

Company Phone Number

vatIdstring

VAT ID

countrystring

Country

addressstring

Address

avatarstring

Avatar URL

facebookUrlstring

Facebook URL

twitterUrlstring

Twitter URL

youtubeUrlstring

YouTube URL

linkedInUrlstring

LinkedIn URL

instagramUrlstring

Instagram URL

Example (auto)

{
  "affiliateFirstName": "John",
  "affiliateLastName": "Deo",
  "affiliateEmail": "[email protected]",
  "phoneNumber": "+1 888 888-8888",
  "websiteUrl": "https://google.com",
  "campaignId": "6385d230f6d19db03eef6fb2",
  "companyName": "Acme Inc",
  "parentAffiliateId": "63d376de11be1d26d38f7369",
  "tier": 2,
  "companyPhoneNumber": "+1 888 888-8888",
  "vatId": "VAT12345",
  "country": "US",
  "address": "123 Main St",
  "avatar": "https://example.com/avatar.jpg",
  "facebookUrl": "https://facebook.com/profile",
  "twitterUrl": "https://twitter.com/profile",
  "youtubeUrl": "https://youtube.com/channel",
  "linkedInUrl": "https://linkedin.com/in/profile",
  "instagramUrl": "https://instagram.com/profile"
}

application/json

Successful response

application/json

Schema

Schema

_idstringrequired

Affiliate id

firstNamestring

Affiliate first name

lastNamestring

Affiliate last name

phonestring

Affiliate phone number

deletedboolean

Whether the affiliate is deleted

locationIdstringrequired

Location id

activeboolean

Whether the affiliate is active

addressstring

Affiliate address

avatarstring

Affiliate avatar URL

createdAtstring

Created at timestamp

createdByobject

Who created the affiliate

facebookUrlstring

Facebook URL

instagramUrlstring

Instagram URL

linkedInUrlstring

LinkedIn URL

twitterUrlstring

Twitter URL

youtubeUrlstring

YouTube URL

websiteUrlstring

Website URL

contactIdstring

Contact id associated with the affiliate

campaignIdsstring[]

Campaign ids

vatIdstring

VAT ID

updatedAtstring

Updated at timestamp

w8Formstring

W-8 form URL

w9Formstring

W-9 form URL

lastUpdatedByobject

Who last updated the affiliate

emailstringrequired

Affiliate email

revenuenumber

Affiliate revenue

companyNamestring

Company name

companyPhoneNumberstring

Company phone number

countrystring

Country the affiliate was created with

commissionTiernumber

Commission tier the affiliate sits in

Example (auto)

{
  "_id": "63d147176c5bbc30e9e091a4",
  "firstName": "John",
  "lastName": "Doe",
  "phone": "+1 888 888-8888",
  "deleted": false,
  "locationId": "ve9EPM428h8vShlRW1KT",
  "active": true,
  "address": "123 Main St",
  "avatar": "https://example.com/avatar.png",
  "createdAt": "2024-06-16T00:00:00.000Z",
  "createdBy": {
    "source": "oauth",
    "channel": "oauth",
    "sourceId": "source_123",
    "sourceName": "Marketplace App",
    "timestamp": "2024-06-16T00:00:00.000Z"
  },
  "facebookUrl": "https://facebook.com/johndoe",
  "instagramUrl": "https://instagram.com/johndoe",
  "linkedInUrl": "https://linkedin.com/in/johndoe",
  "twitterUrl": "https://twitter.com/johndoe",
  "youtubeUrl": "https://youtube.com/channel",
  "websiteUrl": "https://example.com",
  "contactId": "ve9EPM428h8vShlRW1KT",
  "campaignIds": [
    "650173614761b33c46d33b19"
  ],
  "vatId": "VAT123",
  "updatedAt": "2024-06-16T00:00:00.000Z",
  "w8Form": "https://example.com/tax-forms/w8.pdf",
  "w9Form": "https://example.com/tax-forms/w9.pdf",
  "lastUpdatedBy": {
    "source": "oauth",
    "channel": "oauth",
    "sourceId": "source_123",
    "sourceName": "Marketplace App",
    "timestamp": "2024-06-16T00:00:00.000Z"
  },
  "email": "[email protected]",
  "revenue": 1250.5,
  "companyName": "Doe Media LLC",
  "companyPhoneNumber": "+1 888 888-8888",
  "country": "US",
  "commissionTier": 1
}