API documentation

GET /buyer_suppression_files/new

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/buyer_suppression_files/new

Build Suppression File with defaults.

Return a blank Suppression File populated with default attribute values, useful for building a create form.

Params

Param name	Description
name Optional Blank value allowed	Name Must be a String
buyer_suppression_id Optional Blank value allowed	Buyer Suppression Must be a valid foreign key reference to an Buyer Suppression. Refer to: /api/docs/1.0/buyer_suppressions
apply_block_or_unblock Optional Blank value allowed	Apply Block Or Unblock Must be a String
import_file Optional Blank value allowed	Import File Must be a valid file upload.
caller_id_column_name Optional Blank value allowed	Caller Id Column Name Must be a String
headers Optional Blank value allowed	The column headers found in the uploaded CSV file, used to populate the choices for caller_id_column_name. Must be an array of strings. EG: `["abc123", "xzy023"]`

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/buyer_suppression_files/new' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "buyer_suppression_file": {
    "id": null,
    "type": "BuyerSuppressionFile",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/buyer_suppression_files/new",
    "routes_edit_path": "/buyer_suppression_files/new",
    "external_record_id": null,
    "company_id": 10001,
    "name": null,
    "buyer_suppression_id": null,
    "apply_block_or_unblock": "block",
    "import_file_url": null,
    "user_id": null,
    "status": null,
    "caller_id_column_name": null,
    "error_message": null,
    "import_count": null,
    "total_count": null,
    "started_at": null,
    "stopped_at": null,
    "failed_at": null,
    "succeeded_at": null,
    "headers": null
  },
  "metadata": {
    "root": "buyer_suppression_file"
  }
}