Params

Param name
Description
Validations
serializer
Optional Blank Value Allowed

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

Validations:

  • 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

Validations:

  • Must be a String

user_offer_id
Optional Blank Value Allowed

Give this offer a unique ID. Example: IC001

Validations:

  • Must be a String

description
Optional Blank Value Allowed

A human readable description of the record.

Validations:

  • Must be a String

paused
Optional Blank Value Allowed

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

Validations:

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

record_calls
Optional Blank Value Allowed

Record Calls

Validations:

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

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.

Validations:

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