Blacklist: Files API resource for uploading blacklist files.

GET /api/v1/contact_imports
List Blacklist File records.

Params

Param name
Description
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 a String
created_at_from
Optional

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

  • Must be a String
fulltext
Optional

Search for any record that matches this text

  • Must be a 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
  • user_id
  • status
  • data_maps_set
  • name
  • import_file_url
  • data_json
  • error_message
  • import_count
  • total_count
  • started_at
  • stopped_at
  • failed_at
  • succeeded_at
  • unblock_started_at
  • unblock_finished_at
  • apply_block_or_unblock
  • select_import_type
  • import_file_blob
  • description
  • headers

  • Must be a 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_imports/new
Build Blacklist File with defaults.

Params

Param name
Description
name
Optional Blank Value Allowed

Name

  • Must be a String
import_file
Optional Blank Value Allowed

Translation missing: en.api.contact_imports.import_file

  • Must be a valid file upload.
apply_block_or_unblock
Optional Blank Value Allowed

Apply Block Or Unblock

  • Must be one of: block, unblock.
select_import_type
Optional Blank Value Allowed

Upload Import File Or Text

  • Must be one of: file, text_blob.
import_file_blob
Optional Blank Value Allowed

Text Blob

  • Must be a String

POST /api/v1/contact_imports
Create Blacklist File.

Params

Param name
Description
name
Optional Blank Value Allowed

Name

  • Must be a String
import_file
Optional Blank Value Allowed

Translation missing: en.api.contact_imports.import_file

  • Must be a valid file upload.
apply_block_or_unblock
Optional Blank Value Allowed

Apply Block Or Unblock

  • Must be one of: block, unblock.
select_import_type
Optional Blank Value Allowed

Upload Import File Or Text

  • Must be one of: file, text_blob.
import_file_blob
Optional Blank Value Allowed

Text Blob

  • Must be a String

GET /api/v1/contact_imports/:id
Get Blacklist File by id.

PUT /api/v1/contact_imports/:id
Update Blacklist File by id.

Params

Param name
Description
name
Optional Blank Value Allowed

Name

  • Must be a String
import_file
Optional Blank Value Allowed

Translation missing: en.api.contact_imports.import_file

  • Must be a valid file upload.
apply_block_or_unblock
Optional Blank Value Allowed

Apply Block Or Unblock

  • Must be one of: block, unblock.
select_import_type
Optional Blank Value Allowed

Upload Import File Or Text

  • Must be one of: file, text_blob.
import_file_blob
Optional Blank Value Allowed

Text Blob

  • Must be a String