GET /api/v1/unblock_contact_jobs
List Clear Blacklist 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 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
  • user_id
  • description
  • succeeded_at
  • blocked_at_from
  • blocked_at_to
  • request_ip
  • last_contact_id
  • unblock_count
  • 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/unblock_contact_jobs/new
Build Clear Blacklist with defaults.

Params

Param name
Description
description
Optional Blank Value Allowed

Description

  • Must be String

blocked_at_from
Optional Blank Value Allowed

Blocked At From

  • Must be a valid time: 2024-03-29 03:38:01 +0000

blocked_at_to
Optional Blank Value Allowed

Blocked At To

  • Must be a valid time: 2024-03-29 03:38:01 +0000

request_ip
Optional Blank Value Allowed

Request Ip

  • Must be String

last_contact_id
Optional Blank Value Allowed

Last Contact

  • Must be String


POST /api/v1/unblock_contact_jobs
Create Clear Blacklist.

Params

Param name
Description
description
Optional Blank Value Allowed

Description

  • Must be String

blocked_at_from
Optional Blank Value Allowed

Blocked At From

  • Must be a valid time: 2024-03-29 03:38:01 +0000

blocked_at_to
Optional Blank Value Allowed

Blocked At To

  • Must be a valid time: 2024-03-29 03:38:01 +0000

request_ip
Optional Blank Value Allowed

Request Ip

  • Must be String

last_contact_id
Optional Blank Value Allowed

Last Contact

  • Must be String


GET /api/v1/unblock_contact_jobs/:id
Get Clear Blacklist by id.


DELETE /api/v1/unblock_contact_jobs/:id
Destroy Clear Blacklist by id.