Supported Formats

json

Params

Param name
Description
serializer
Optional Blank Value Allowed

This endpoint supports multiple response formats. Pass serializer=name to retrieve data in an alternate format.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    offerDefault response format.
    offer_gridModern response format that returns various foreign keys for use with other API endpoints.
name
Optional Blank Value Allowed

Give this offer a name. Example: Insurance Calls

  • Must be String

user_offer_id
Optional Blank Value Allowed

Give this offer a unique ID. Example: IC001

  • Must be String

description
Optional Blank Value Allowed

A human readable description of the record.

  • Must be String

paused
Optional Blank Value Allowed

Pause or unpause the offer. Paused offers will reject all calls and disable all schedules.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

record_calls
Optional Blank Value Allowed

Record Calls

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off

data_append_type
Optional Blank Value Allowed

Append additional information (such as zip code and address) to a lead, may incur additional charges.

  • Must be a value contained in the pick list:
    Acceptable ValueDescription
    free_zip_codeFree Zip Code
    zipAdvanced Zip Code
    addressAddress Data
    fullFull Data
record_calls_require_authorization
Optional Blank Value Allowed

Require the user to be logged into TrackDrive, with access to your company, in order to have permission to download call recordings on this offer.

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off