Leadspedia

Schedule

Lead Contract Schedule

Get Schedule

GET
/core/v2/leadDistributionContracts/getSchedule.do

Parameters

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

Create Schedule

POST
/core/v2/leadDistributionContracts/createSchedule.do

When using this endpoint each day of the week is optional, however at least one or more day(s) must be passed with a value of yes.

Parameters

  • Name
    contractID
    Type
    integer
    Required
    required
  • Name
    type
    Type
    enum
    Required
    required
    Allowed values
    Allowed values: Exclusive Multisell
  • Name
    price
    Type
    integer
    Required
    required
  • Name
    cap
    Type
    integer
    Required
    required
    Description
    If you do not want a Schedule Cap pass a value of 0
  • Name
    revenueCap
    Type
    integer
    Required
    required
    Description
    If you do not want a Schedule Revenue Cap pass a value of 0
  • Name
    startTime
    Type
    string
    Required
    required
    Description
    HH:mm
  • Name
    endTime
    Type
    string
    Required
    required
    Description
    HH:mm
  • Name
    Monday
    Type
    enum
    Allowed values
    Allowed values: Yes No
  • Name
    Tuesday
    Type
    enum
    Allowed values
    Allowed values: Yes No
  • Name
    Wednesday
    Type
    enum
    Allowed values
    Allowed values: Yes No
  • Name
    Thursday
    Type
    enum
    Allowed values
    Allowed values: Yes No
  • Name
    Friday
    Type
    enum
    Allowed values
    Allowed values: Yes No
  • Name
    Saturday
    Type
    enum
    Allowed values
    Allowed values: Yes No
  • Name
    Sunday
    Type
    enum
    Allowed values
    Allowed values: Yes No

Request Sample

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

Update Schedule

POST
/core/v2/leadDistributionContracts/updateSchedule.do

Parameters

  • Name
    deliveryScheduleID
    Type
    integer
    Required
    required
  • Name
    type
    Type
    enum
    Allowed values
    Allowed values: Exclusive Multisell
  • Name
    price
    Type
    integer
  • Name
    startTime
    Type
    string
    Description
    HH:mm
  • Name
    endTime
    Type
    string
    Description
    HH:mm
  • Name
    cap
    Type
    integer
  • Name
    revenueCap
    Type
    integer

Request Sample

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

Delete Schedule

POST
/core/v2/leadDistributionContracts/deleteSchedule.do

Parameters

  • Name
    deliveryScheduleID
    Type
    integer
    Required
    required

Request Sample

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

Delete All Schedules

POST
/core/v2/leadDistributionContracts/deleteAllSchedules.do

Parameters

  • Name
    contractID
    Type
    integer
    Required
    required

Request Sample

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

Set All Schedule Price

POST
/core/v2/leadDistributionContracts/setPrice.do

This endpoint sets the schedule price for all schedules within the specified Contract.

Parameters

  • Name
    contractID
    Type
    integer
    Required
    required
  • Name
    price
    Type
    integer
    Required
    required

Request Sample

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