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
    scheduleDefault response format.
    schedule_gridModern response format that returns various foreign keys for use with other API endpoints.
name
Optional Blank Value Allowed

Name

Validations:

  • Must be a String

offer_id
Optional Blank Value Allowed

Offer

Validations:

description
Optional Blank Value Allowed

A human readable description of the record.

Validations:

  • Must be a String

paused
Optional Blank Value Allowed

Paused

Validations:

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

sortable_order
Optional Blank Value Allowed

The order in which records will be sorted. Values are sorted in ascending order; smaller values are listed first.

Validations:

  • Must be a decimal number.