API documentation

PUT /call_recording_rules/:id

Authorization Required

https://[your-subdomain].trackdrive.com/api/v1/call_recording_rules/:id

Update Call Recording Retention by id.

Updates a Call Recording Retention rule's retention period, recording_type, or the offer, schedule, buyer, or traffic source it applies to.

Params

Param name	Description
description Optional Blank value allowed	Description Must be a String
recording_type Optional Blank value allowed	This type of recording will be deleted once the retention period has passed. Must be one of: `call`, `consumer_and_agent`, `consumer_and_buyer`.
retention_seconds Optional Blank value allowed	If a recording is older than this many seconds, it will be deleted. Must be a decimal number.
offer_id Optional Blank value allowed	Only recordings matching this offer will be deleted after the retention period. Must be a valid foreign key reference to an Offer. Refer to: /api/docs/1.0/offers
schedule_id Optional Blank value allowed	Only recordings matching this Schedule will be deleted after the retention period. Must be a valid foreign key reference to an Schedule. Refer to: /api/docs/1.0/schedules
buyer_id Optional Blank value allowed	Only recordings matching this Buyer will be deleted after the retention period. Must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers
traffic_source_id Optional Blank value allowed	Only recordings matching this Traffic Source will be deleted after the retention period. Must be a valid foreign key reference to an Traffic Source. Refer to: /api/docs/1.0/traffic_sources

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/call_recording_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "description": "Example Call Recording Rule (renamed)"
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "call_recording_rule": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "CallRecordingRule",
    "uuid": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": "2026-01-15T15:30:00.000Z",
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/call_recording_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/call_recording_rules/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "company_id": 10001,
    "user_id": null,
    "sortable_order": -8,
    "description": "Example Call Recording Rule (renamed)",
    "recording_type": "call",
    "retention_seconds": 604800,
    "offer_id": null,
    "schedule_id": null,
    "buyer_id": null,
    "traffic_source_id": null,
    "completed_at": null
  },
  "metadata": {
    "root": "call_recording_rule"
  }
}