Params

Param name
Description
offer_id
Optional

translation missing: en.api.contact_field_views.offer_id

ids
Optional

Return records matching these ids.

  • Must be an array of decimal values. EG: [0, 1, 2, 3]

page
Optional

Return the next page of results.

  • Must be a number.

per_page
Optional

How many results to return per page. The default is 25.

  • Must be a number.

created_at_to
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be String

created_at_from
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be String

fulltext
Optional

Search for any record that matches this text

  • Must be String

time_zone
Optional

Date ranges will be parsed using this time zone.

columns
Optional
Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at

Must be any combination of:

  • id
  • legacy_id
  • type
  • uuid
  • created_at
  • updated_at
  • deleted_at
  • user_updated_at
  • routes_show_path
  • routes_edit_path
  • external_record_id
  • company_id
  • offer_id
  • sortable_order
  • script_javascript
  • jornaya_campaign_id
  • fields_type
  • title
  • script_html
  • token_keys
  • is_default
  • name
  • context_menu_name
  • use_when_tokens_match
  • template_description
  • template_enabled
  • template_tier
  • record_token_filter_id
  • record_token_filter_data_count
  • record_token_filter_data
  • record_token_additional_id
  • record_token_additional_data_count
  • record_token_additional_data
  • Must be String

root
Optional

Pass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}

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


GET /api/v1/contact_field_views/new
Build record with defaults.

Params

Param name
Description
offer_id
Optional

Assign the record to this Offer.

title
Optional Blank Value Allowed

Agent Script Display Name

  • Must be String

fields_type
Optional Blank Value Allowed

A unique value that will be submitted with leads to select this field type and agent script.

  • Must be String

script_html
Optional Blank Value Allowed

This script will be displayed to agents when they are answering calls from consumers. Contact fields in this script will be replaced with inputs, allowing the agent to enter responses inline in the script.

  • Must be String

token_keys
Optional Blank Value Allowed

These fields will be visible when this field_type is selected.

  • Must be an array of any type

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.

  • Must be a decimal number.


Params

Param name
Description
title
Required

Agent Script Display Name

  • Must be String

offer_id
Required

Assign the record to this Offer.

fields_type
Optional Blank Value Allowed

A unique value that will be submitted with leads to select this field type and agent script.

  • Must be String

script_html
Optional Blank Value Allowed

This script will be displayed to agents when they are answering calls from consumers. Contact fields in this script will be replaced with inputs, allowing the agent to enter responses inline in the script.

  • Must be String

token_keys
Optional Blank Value Allowed

These fields will be visible when this field_type is selected.

  • Must be an array of any type

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.

  • Must be a decimal number.



Params

Param name
Description
offer_id
Optional

Assign the record to this Offer.

title
Optional

Agent Script Display Name

  • Must be String

fields_type
Optional Blank Value Allowed

A unique value that will be submitted with leads to select this field type and agent script.

  • Must be String

script_html
Optional Blank Value Allowed

This script will be displayed to agents when they are answering calls from consumers. Contact fields in this script will be replaced with inputs, allowing the agent to enter responses inline in the script.

  • Must be String

token_keys
Optional Blank Value Allowed

These fields will be visible when this field_type is selected.

  • Must be an array of any type

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.

  • Must be a decimal number.