API documentation

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"
  }
}