Update Affiliate Status

PUT 
/affiliate-manager/:locationId/affiliates/:affiliateId/status

Activate or deactivate an affiliate. Sending the same value again leaves the affiliate unchanged.

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

Location Id

affiliateId stringrequired

Affiliate Id

application/json

application/json

Body

Bodyrequired

activebooleanrequired

Whether the affiliate is active. Sending the same value twice leaves the affiliate unchanged.

Example (auto)

{
  "active": false
}

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
}