Leadspedia

Advanced Settings

Lead Contract Advanced Settings

Get Leads Settings

GET
/core/v2/leadDistributionContracts/getLeadsSettings.do

Parameters

  • Name
    contractID
    Type
    integer
    Required
    required

Request Sample

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

Update Lead Settings

POST
/core/v2/leadDistributionContracts/updateLeadsSettings.do

Parameters

  • Name
    contractID
    Type
    integer
    Required
    required
  • Name
    minimumLeadAge
    Type
    integer
    Description
    Minimum lead age in minutes to deliver to this contract
  • Name
    maximumLeadAge
    Type
    integer
    Description
    Maximum lead age in minutes to deliver to this contract
  • Name
    maximumPostErrors
    Type
    integer
    Description
    Maximum concurrent error posts to inactivate the contract
  • Name
    timeLeadsPosts
    Type
    integer
    Description
    Do not post leads within X amount of post seconds
  • Name
    allowQueueLeads
    Type
    enum
    Description
    Allow queue to send leads to this contract
    Allowed values
    Allowed values: Yes No

Request Sample

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

Get Portal Settings

GET
/core/v2/leadDistributionContracts/getPortalSettings.do

Parameters

  • Name
    contractID
    Type
    integer
    Required
    required

Request Sample

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

Update Portal Settings

POST
/core/v2/leadDistributionContracts/updatePortalSettings.do

Parameters

  • Name
    contractID
    Type
    integer
    Required
    required
  • Name
    showStatus
    Type
    enum
    Allowed values
    Allowed values: Yes No
  • Name
    allowStatusPause
    Type
    enum
    Description
    Allow advertiser to pause contract
    Allowed values
    Allowed values: Yes No
  • Name
    showLeadData
    Type
    enum
    Allowed values
    Allowed values: Yes No
  • Name
    showSchedule
    Type
    enum
    Allowed values
    Allowed values: Yes No
  • Name
    allowUpdateSchedule
    Type
    enum
    Description
    Allow advertiser to manage delivery schedule
    Allowed values
    Allowed values: Yes No
  • Name
    showCaps
    Type
    enum
    Allowed values
    Allowed values: Yes No
  • Name
    allowManageCaps
    Type
    enum
    Description
    Allow advertiser to manage caps
    Allowed values
    Allowed values: Yes No
  • Name
    showReturnSettings
    Type
    enum
    Allowed values
    Allowed values: Yes No

Request Sample

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

Set Expiration Date

POST
/core/v2/leadDistributionContracts/setExpirationDate.do

Parameters

  • Name
    contractID
    Type
    integer
    Required
    required
  • Name
    expirationDate
    Type
    date
    Required
    required
    Matching Pattern
    Match Pattern: YYYY-MM-DD

Request Sample

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

Remove Expiration Date

POST
/core/v2/leadDistributionContracts/removeExpirationDate.do

Parameters

  • Name
    contractID
    Type
    integer
    Required
    required

Request Sample

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

Get Schedule Pause

GET
/core/v2/leadDistributionContracts/getScheduledPause.do

Parameters

  • Name
    contractID
    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/leadDistributionContracts/getScheduledPause.do \
  --header 'Authorization: Basic Og=='

Create Schedule Pause

POST
/core/v2/leadDistributionContracts/schedulePause.do

Parameters

  • Name
    contractID
    Type
    integer
    Required
    required
  • Name
    pauseDate
    Type
    date
    Required
    required
    Description
    Pause date has to be later than today's date but before the resume date
    Matching Pattern
    Match Pattern: YYYY-MM-DD
  • Name
    resumeDate
    Type
    date
    Required
    required
    Matching Pattern
    Match Pattern: YYYY-MM-DD

Request Sample

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

Delete Schedule Pause

POST
/core/v2/leadDistributionContracts/deleteScheduledPause.do

Parameters

  • Name
    scheduledPauseID
    Type
    integer
    Required
    required

Request Sample

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