Leadspedia

Affiliates

Get All

GET
/core/v2/affiliates/getAll.do

Parameters

  • Name
    status
    Type
    enum
    Allowed values
    Allowed values: Active Pending InActive
  • Name
    search
    Type
    string
  • Name
    affiliateID
    Type
    integer
  • Name
    accountManagerID
    Type
    integer
  • Name
    start
    Type
    integer
    Description
    Offset of the first row to return.
    Default value
    Default value: 0
  • Name
    limit
    Type
    integer
    Description
    Maximum number of rows to return. Cannot be greater than 1000.
    Default value
    Default value: 100

Request Sample

curl --request GET \
  --url https://api.leadspedia.com/core/v2/affiliates/getAll.do \
  --header 'Authorization: Basic Og=='

Search

GET
/core/v2/affiliates/search.do

Parameters

  • Name
    search
    Type
    string
    Required
    required
  • Name
    start
    Type
    integer
    Description
    Offset of the first row to return.
    Default value
    Default value: 0
  • Name
    limit
    Type
    integer
    Description
    Maximum number of rows to return. Cannot be greater than 1000.
    Default value
    Default value: 100

Request Sample

curl --request GET \
  --url https://api.leadspedia.com/core/v2/affiliates/search.do \
  --header 'Authorization: Basic Og=='

Get

GET
/core/v2/affiliates/getInfo.do

Parameters

  • Name
    affiliateID
    Type
    integer
    Required
    required

Request Sample

curl --request GET \
  --url https://api.leadspedia.com/core/v2/affiliates/getInfo.do \
  --header 'Authorization: Basic Og=='

Create

POST
/core/v2/affiliates/create.do

Parameters

  • Name
    affiliateName
    Type
    string
    Required
    required
  • Name
    accountManagerID
    Type
    integer
    Required
    required
  • Name
    status
    Type
    enum
    Required
    required
    Allowed values
    Allowed values: Active Pending InActive

Request Sample

curl --request POST \
  --url https://api.leadspedia.com/core/v2/affiliates/create.do \
  --header 'Authorization: Basic Og=='

Update

POST
/core/v2/affiliates/updateInfo.do

Parameters

  • Name
    affiliateID
    Type
    integer
    Required
    required
  • Name
    affiliateName
    Type
    string
    Description
    >= 1 characters
  • Name
    alternateID
    Type
    string
  • Name
    address
    Type
    string
  • Name
    address2
    Type
    string
  • Name
    city
    Type
    string
  • Name
    state
    Type
    string
  • Name
    zipCode
    Type
    string
  • Name
    country
    Type
    string
  • Name
    website
    Type
    string

Request Sample

curl --request POST \
  --url https://api.leadspedia.com/core/v2/affiliates/updateInfo.do \
  --header 'Authorization: Basic Og=='

Change Status

POST
/core/v2/affiliates/changeStatus.do

Parameters

  • Name
    affiliateID
    Type
    integer
    Required
    required
  • Name
    status
    Type
    enum
    Required
    required
    Allowed values
    Allowed values: Active Pending InActive

Request Sample

curl --request POST \
  --url https://api.leadspedia.com/core/v2/affiliates/changeStatus.do \
  --header 'Authorization: Basic Og=='

Update Billing

POST
/core/v2/affiliates/updateBilling.do

Parameters

  • Name
    affiliateID
    Type
    integer
    Required
    required
  • Name
    billingCycle
    Type
    enum
    Allowed values
    Allowed values: Monthly BiMonthly Weekly Two Months Quarterly Manual Other

Request Sample

curl --request POST \
  --url https://api.leadspedia.com/core/v2/affiliates/updateBilling.do \
  --header 'Authorization: Basic Og=='

Delete

POST
/core/v2/affiliates/delete.do

Parameters

  • Name
    affiliateID
    Type
    integer
    Required
    required

Request Sample

curl --request POST \
  --url https://api.leadspedia.com/core/v2/affiliates/delete.do \
  --header 'Authorization: Basic Og=='