Leadspedia

Returns

Lead Returns

Get Returns

GET
/core/v2/leads/getReturns.do

Parameters

  • Name
    fromDate
    Type
    date
    Required
    required
    Matching Pattern
    Match Pattern: YYYY-MM-DD
  • Name
    toDate
    Type
    date
    Matching Pattern
    Match Pattern: YYYY-MM-DD
  • Name
    verticalID
    Type
    integer
  • Name
    advertiserID
    Type
    integer
  • Name
    contractID
    Type
    integer
  • Name
    affiliateID
    Type
    integer
  • Name
    campaignID
    Type
    integer
  • Name
    status
    Type
    enum
    Allowed values
    Allowed values: Pending Approved Rejected Attempted Contact Researching
  • Name
    returnReasonID
    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/leads/getReturns.do \
  --header 'Authorization: Basic Og=='

Return Lead

POST
/core/v2/leads/returnLead.do

Parameters

  • Name
    leadID
    Type
    string
    Required
    required
  • Name
    contractID
    Type
    integer
    Required
    required
  • Name
    returnReasonID
    Type
    integer
    Required
    required
  • Name
    replaceReturns
    Type
    enum
    Allowed values
    Allowed values: Yes No
  • Name
    scrub
    Type
    enum
    Allowed values
    Allowed values: Yes No

Request Sample

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

Return Lead From All Contracts

POST
/core/v2/leads/returnLeadFromAllContracts.do

Parameters

  • Name
    leadID
    Type
    string
    Required
    required
  • Name
    returnReasonID
    Type
    integer
    Required
    required
  • Name
    replaceReturns
    Type
    enum
    Allowed values
    Allowed values: Yes No
  • Name
    scrub
    Type
    enum
    Allowed values
    Allowed values: Yes No

Request Sample

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

Unreturn Lead

POST
/core/v2/leads/unreturnLead.do

Parameters

  • Name
    leadID
    Type
    string
    Required
    required
  • Name
    contractID
    Type
    integer
    Required
    required
  • Name
    rejectReasonID
    Type
    integer
    Required
    required

Request Sample

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

Request Return

POST
/core/v2/leads/requestReturn.do

Parameters

  • Name
    leadID
    Type
    string
    Required
    required
  • Name
    contractID
    Type
    integer
    Required
    required
  • Name
    returnReasonID
    Type
    integer
    Required
    required
  • Name
    returnNotes
    Type
    string

Request Sample

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

Approve Return Request

POST
/core/v2/leads/approveReturn.do

Parameters

  • Name
    leadID
    Type
    string
    Required
    required
  • Name
    contractID
    Type
    integer
    Required
    required

Request Sample

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

Reject Return Request

POST
/core/v2/leads/rejectReturn.do

Parameters

  • Name
    leadID
    Type
    string
    Required
    required
  • Name
    contractID
    Type
    integer
    Required
    required
  • Name
    rejectReasonID
    Type
    integer
    Required
    required

Request Sample

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