API documentation

GET /sip_headers

Authorization Required

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

List Sip Header records.

Lists the custom SIP headers configured for your account - key/value pairs Trackdrive sends to a buyer over SIP trunking when it connects a call. Supports the common index filters plus an ids filter, and defaults to newest-first ordering. Requires read permission on SIP headers.

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. Must be a valid time zone. See the list of valid time zones.
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 buyer_id key value name company_id record_token_filter_id record_token_filter_data_count record_token_filter_data 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

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/sip_headers/?per_page=2' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "sip_headers": [
    {
      "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "type": "SipHeader",
      "uuid": "a09e6bca-255b-4217-af73-cb9601c80217",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": null,
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/sip_headers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
      "routes_edit_path": "/sip_headers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
      "external_record_id": null,
      "buyer_id": 10001,
      "key": "x_ph_first_name",
      "value": "{{first_name}}",
      "name": "x_ph_first_name",
      "company_id": 10002,
      "record_token_filter_id": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": []
    },
    {
      "id": "49cca320-d2dd-4768-a730-8fc3e0a664e7",
      "type": "SipHeader",
      "uuid": "8a10bcf5-8767-4aa3-a10b-5458e72d5bf9",
      "created_at": "2026-01-15T15:30:00.000Z",
      "updated_at": null,
      "deleted_at": null,
      "user_updated_at": null,
      "routes_show_path": "/sip_headers/49cca320-d2dd-4768-a730-8fc3e0a664e7",
      "routes_edit_path": "/sip_headers/49cca320-d2dd-4768-a730-8fc3e0a664e7/edit",
      "external_record_id": null,
      "buyer_id": 10001,
      "key": "x_ph_td_uuid",
      "value": "{{uuid}}",
      "name": "x_ph_td_uuid",
      "company_id": 10002,
      "record_token_filter_id": null,
      "record_token_filter_data_count": 0,
      "record_token_filter_data": []
    }
  ],
  "metadata": {
    "root": "sip_headers",
    "page": 1,
    "total_pages": 1,
    "per_page": 2,
    "total_count": 2,
    "next_cursor": 10003
  }
}

GET /sip_headers/new

Authorization Required

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

Build Sip Header with defaults.

Returns an unsaved SIP header built from any submitted attributes and account defaults, without creating a record - useful for previewing values before calling create. Requires create permission on SIP headers.

Params

Param name	Description
id Optional Blank value allowed	Id Must be a 128-bit UUID reference to an object on Trackdrive, such as 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
buyer_id Optional Blank value allowed	Buyer Must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers
key Optional Blank value allowed	Key Must be a String
value Optional Blank value allowed	Value Must be a String
token_value_ids Optional Blank value allowed	Assign the internal ids for filtering. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Token Value. Refer to: /api/docs/1.0/token_values
record_token_filter_list Optional Blank value allowed	Assign filters to the object by passing an array of key:value pairs Must be a valid list of filters. Example filters: `"interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"`

Example Request

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

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "sip_header": {
    "id": null,
    "type": "SipHeader",
    "uuid": null,
    "created_at": null,
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/sip_headers/new",
    "routes_edit_path": "/sip_headers/new",
    "external_record_id": null,
    "buyer_id": null,
    "key": null,
    "value": null,
    "name": null,
    "company_id": 10001,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "sip_header"
  }
}

POST /sip_headers

Authorization Required

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

Create Sip Header.

Creates a SIP header tied to a specific buyer_id. Both key and value can contain token placeholders that Trackdrive resolves per call, and the value is treated as sensitive and URL-encoded when sent. Pass copy_id to clone an existing SIP header's attributes as a starting point. Requires create permission on SIP headers.

Params

Param name	Description
id Optional Blank value allowed	Id Must be a 128-bit UUID reference to an object on Trackdrive, such as 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
buyer_id Optional Blank value allowed	Buyer Must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers
key Optional Blank value allowed	Key Must be a String
value Optional Blank value allowed	Value Must be a String
token_value_ids Optional Blank value allowed	Assign the internal ids for filtering. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Token Value. Refer to: /api/docs/1.0/token_values
record_token_filter_list Optional Blank value allowed	Assign filters to the object by passing an array of key:value pairs Must be a valid list of filters. Example filters: `"interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"`

Example Request

curl -X POST 'https://[your-subdomain].trackdrive.com/api/v1/sip_headers/' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "buyer_id": 10001,
  "key": "x_ph_example_key",
  "value": "value_token"
}'

Example Response 201

{
  "status": 201,
  "success": true,
  "errors": {},
  "sip_header": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "SipHeader",
    "uuid": null,
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/sip_headers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/sip_headers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "buyer_id": 10001,
    "key": "x_ph_example_key",
    "value": "value_token",
    "name": "x_ph_example_key",
    "company_id": 10002,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "sip_header"
  }
}

GET /sip_headers/:id

Authorization Required

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

Get Sip Header by id.

Retrieves a single SIP header by id, scoped to your account. Requires read permission on SIP headers.

Example Request

curl 'https://[your-subdomain].trackdrive.com/api/v1/sip_headers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "sip_header": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "SipHeader",
    "uuid": "a09e6bca-255b-4217-af73-cb9601c80217",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/sip_headers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/sip_headers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "buyer_id": 10001,
    "key": "x_ph_first_name",
    "value": "{{first_name}}",
    "name": "x_ph_first_name",
    "company_id": 10002,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "sip_header"
  }
}

PUT /sip_headers/:id

Authorization Required

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

Update Sip Header by id.

Updates an existing SIP header's key, value, or associated buyer_id by id. Requires update permission on SIP headers.

Params

Param name	Description
id Optional Blank value allowed	Id Must be a 128-bit UUID reference to an object on Trackdrive, such as 924c37d5-e70f-42ad-84c2-e85eb0c1bc21
buyer_id Optional Blank value allowed	Buyer Must be a valid foreign key reference to an Buyer. Refer to: /api/docs/1.0/buyers
key Optional Blank value allowed	Key Must be a String
value Optional Blank value allowed	Value Must be a String
token_value_ids Optional Blank value allowed	Assign the internal ids for filtering. Must be a valid array of integers. Each integer ID must be a valid foreign key reference to an Token Value. Refer to: /api/docs/1.0/token_values
record_token_filter_list Optional Blank value allowed	Assign filters to the object by passing an array of key:value pairs Must be a valid list of filters. Example filters: `"interest:auto", "loan_amount:>=10000", "loan_amount:<=50000", "geo:!=800", "caller_id:!=anonymous"`

Example Request

curl -X PUT 'https://[your-subdomain].trackdrive.com/api/v1/sip_headers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "value": "value_token_renamed"
}'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "sip_header": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "SipHeader",
    "uuid": "a09e6bca-255b-4217-af73-cb9601c80217",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": null,
    "deleted_at": null,
    "user_updated_at": null,
    "routes_show_path": "/sip_headers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/sip_headers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "buyer_id": 10001,
    "key": "x_ph_example_key",
    "value": "value_token_renamed",
    "name": "x_ph_example_key",
    "company_id": 10002,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "sip_header"
  }
}

DELETE /sip_headers/:id

Authorization Required

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

Destroy Sip Header by id.

Soft-deletes the SIP header by id; the record is excluded from normal results but recoverable rather than permanently removed. Requires destroy permission on SIP headers.

Example Request

curl -X DELETE 'https://[your-subdomain].trackdrive.com/api/v1/sip_headers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09' \
  -H 'Authorization: Basic BASE64_ENCODED_PUBLIC_KEY_AND_PRIVATE_KEY'

Example Response 200

{
  "status": 200,
  "success": true,
  "errors": {},
  "sip_header": {
    "id": "a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "type": "SipHeader",
    "uuid": "a09e6bca-255b-4217-af73-cb9601c80217",
    "created_at": "2026-01-15T15:30:00.000Z",
    "updated_at": null,
    "deleted_at": "2026-01-15T15:30:00.000Z",
    "user_updated_at": null,
    "routes_show_path": "/sip_headers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09",
    "routes_edit_path": "/sip_headers/a6af7847-1b1e-4760-ac0d-e1813a6d3a09/edit",
    "external_record_id": null,
    "buyer_id": 10001,
    "key": "x_ph_example_key",
    "value": "value_token",
    "name": "x_ph_example_key",
    "company_id": 10002,
    "record_token_filter_id": null,
    "record_token_filter_data_count": 0,
    "record_token_filter_data": []
  },
  "metadata": {
    "root": "sip_header"
  }
}

Params

Must be any combination of:

Params

Params

Params