Dispatchable
  1. templates
Dispatchable
  • Contacts
    • Porperties
      • All
      • Create
      • Read
      • Update
      • Delete
    • Sub Contacts
      • All
      • Create
      • Read
      • Update
      • Delete
    • Contact Exists
      GET
    • All Contacts
      GET
    • Create
      POST
    • Read
      GET
    • Update
      PUT
    • Delete
      DELETE
  • Emails
    • sendgrid
      • Index
      • Create
      • Read
      • Update
      • Delete
    • Imap
      • Index
      • Create
      • Read
      • Update
      • Delete
    • support
      • Contact Support
    • Index
      GET
    • Create Email
      POST
    • Show Email Details
      GET
    • Default Mailserver
      GET
  • Attachments
    • Get All Attachments
    • Store
    • Read
    • Update
    • Delete
  • Companies
    • Details
      • Get Brand
      • Update Brand
    • Portal
      • Company Portal Access
    • Get User
    • Create Company
    • Get Users Company
    • Update
  • Bill Of Ladings
    • Records
      • Get all
      • Create
    • Inspection Photos
      • Store
      • Get All Photos
  • Carriers
    • public
      • Get All Carriers
      • Validate Carrier by MC or USDOT number
    • FMSCA
      • Get Carrier
    • Central Dispatch
      • Get Carriers
      • Get Carrier
    • saved
      • Search Carriers
      • Save Carrier
      • Read
      • Update
      • Delete
      • Recently
    • Get All Carriers
    • Store
    • Read
    • Edit
    • Validate Carrier
    • Show
  • Dispatches
    • Carrier
      • Carrier Accept
      • Carrier Decline
      • Carrier Counter
      • Carrier Cancel
      • Carrier Update
    • Load
      • Get Load Dispatch
    • Intelligence
      • Get Prices
      • Get Pricing
    • portal
      • Carrier Portal Dispatch Review
      • Carrier Portal Dispatch Accept
      • Carrier Portal Dispatch Update
      • Carrier Portal Dispatch Validate Access
      • Shipper Dispatch by Tracking
    • Inspection Photos
      • Vehicles
        • Get Inspection Photos
        • Create
        • Read
        • Delete
      • Freight
        • Get Photo
        • Index
        • Upload
    • Inspection Report
      • Vehicle Damage Report
        • Create
        • Read
        • Update
      • signatures
        • Get Signatures
        • Create
        • Send Touchless Link via SMS
        • Sign and Accept Inspection
    • Vehicle Bill of Lading
      • Send BOL to Shipper via Email
      • Send BOL to Shipper via Copy
    • Get All
    • Create
    • Show
    • Update
    • Cancel Dispatch
    • Remind Carrier
  • Invoices
    • Invoice Items
      • Add Item
      • Edit Item
      • Delete Item
      • Get Item
      • Get All Items
    • Summary
    • Get All
    • Read
    • Store
    • Update
    • Delete
  • Listings
    • Offers
      • Create Offer
      • Get All Offers
    • Listings
      • Delete All Load Listings
      • Remove From Loadboard
      • Sync Listing
      • Get All listings
      • Get Listing
      • Store Listing
      • Update Listing
      • Delete
    • Central Dispatch
      • Get All
      • Delete
      • Delete All
      • Get Listing
    • Central Dispatch Intelligence
  • Loads
    • Vehicles
      • Get All
      • Get Vehicle
      • Add Vehicle
      • Add Vehicle Copy
      • Add Vehicle Copy Copy
    • Commodities
      • Index
      • Create
      • Read
      • Update
      • Delete
    • portal
      • shippers
        • Create Load
        • Get Load
        • Update Load
        • Accept Load
        • Get Load by Tracking
      • carriers
        • Carrier Portal Review Load to Dispatch
        • Carrier Portal Get Accepted Load
    • Assignment Rules
      • Index
      • Create
      • Read
      • Update
      • Delete
    • dashboard
      • Summary
    • Reports
      • Source Reports
    • Invoice Items
      • Index
      • Create
      • Read
      • Update
      • Delete
    • settings
      • Load Settings
      • Load Settings - Auto Transport
    • Clients
      • Get Clients Loads
    • Duplicate
    • Re Assign
    • Update Status
    • Index
    • Create
    • Read
    • Update
    • Delete
    • Update Carrier Status
    • Quick Create
    • Send Load Link
  • Payments
    • Portal
      • Save Card
      • Delete Card from Load
      • Charge Card
      • Get Card
      • Get Billing Profiles
      • Payment
    • Gateway
      • Get Gateway
      • Update
      • Get All Gateways
    • Authorize Net
      • Get account
      • Update
    • dashboard
      • Summary
    • reporting
      • Transactions
    • Contact Profile
      • Get Cards
      • Save Card
      • Delete
    • applied
      • Get All Applied
      • Apply Payment
      • Delete Payment
    • Edit
    • Index
    • Get Payment
    • Store
    • Delete Payment
  • Vehicles
    • Vehicles
      • Get All Vehicles
      • Get vehicle
      • Store
      • Delete
    • Load Vehicle
      • Store
      • Get All
      • Update
    • Makes
    • Models
    • Vin
  • Webforms
    • Get All
    • Store
    • Show
    • Portal Show
    • Get By Subdomain
  • Mail Server
    • Outoing
      • Get All
      • Send
      • Get
    • Server
      • Get All
      • Store
      • Show
      • Update
      • Delete
    • Untitled Endpoint
  • Trips
    • Get data
    • Post data
    • Update Trip Number
    • Update data
    • Delete data
  • Notes
    • Index
    • Read
    • Create
    • Update
    • Delete
  • Tasks
    • Get data
    • Post data
    • Update data
    • Delete data
  • Trucks
    • Drivers
      • Get Drivers
      • Create Driver
    • Fleets
      • Create Fleets
      • Create Fleets
    • Get trucks
    • Create Truck
    • Read Truck
    • Update Truck
    • Delete
  • Shippers
    • Get User Details
    • Get Shippers
    • Create Shipper
    • Read Shippers
    • Update Shipper
    • Delete Shipper
  • Deliveries
    • Get User Details
    • Get Deliveries
    • Create Deliveries
    • Read Deliveries
    • Update Deliveries
    • Delete
  • SMS
    • twilio
      • Get Accounts
      • Create Account
      • Delete
      • Edit
    • Index
    • Send Message
    • Get Message Details
  • Tags
    • Preset Tags
      • Index Preset Tags
      • Create Preset Tag
      • Delete Preset Tags
      • Create Preset Tag
    • Index Tags
    • Create Tag
    • Delete Tag
    • Get Tag
  • Portal
  • Documents
    • templates
      • Get all
        GET
      • Create Template
        POST
      • Read
        GET
      • Update
        PUT
      • Delete
        DELETE
      • Template Preview
        POST
      • Template Preview Raw
        POST
    • load documents
      • vehicles
        • Shipper's Agreement
        • Load and Rate Confirmation Agreement
        • Rate Sheet
        • Bill of Lading
        • ePod
      • freight
        • Shipping Agreement
        • Load and Rate Confirmation Agreement
        • Freight Rate Sheet
        • Bill of Lading
        • Epod
      • Payment Receipt
      • Invoice
      • Carrier Agreement
    • Index
      GET
    • Create
      POST
    • Read
      GET
    • Update
      POST
    • Send
      POST
    • Delete
      DELETE
    • Test
      POST
  • Data Manager
    • sources
      • All
      • Index
      • Create
      • Read
      • Update
      • Delete
      • Portal Source
    • Providers
      • Index
      • Create
      • Read
      • Update
      • Delete
  • History
    • New History
    • Index
  • Vendors
  • Route Engine
    • Cronetic
      • Zip Code Auto Complete
    • autoquote-formula
      • Index
      • Create
      • Read
      • Update
      • Delete
      • Quote
    • Formulas
      • Index
      • Create
      • Read
      • Update
      • Delete
      • Generate Quote
      • Quick Quote
    • Lane Details
    • Search by Zip
    • Search by Address
    • Search by Place Id
    • Route Calc
  • Custom Modules
    • Fields
      • Create Field
      • Index
      • Update
      • Delete
      • Read
    • Records
      • Create
      • Update
      • Delete
      • Read
      • Index
    • modules
      • Create
      • Update
      • Delete
      • Index
      • Read
  • Data Importer
    • Cronetic
      • account
        • Start
        • Read
        • Validate
        • Sync
        • Sync Users
        • Fetch Users
      • loads
        • Import Lead
        • Import Quote
        • Import Order
  • Billing
    • Account
      • Show
    • Cards
      • Setup Intent
      • Add Card
      • Delete
      • Get Cards
    • Admin
      • Plans
        • Plans
    • Subscriptions
      • Subscribe
      • Update
      • Cancel Subscription
      • Change Method of Payment
      • Get Subscription Details
    • Payments
      • History
  • Automations
    • webhooks
      • Index
      • Create
      • Read
      • Delete
      • Update
      • Execute Webhook
    • modules
      • Get Tokens
    • Automations
      • List all automations
      • Create a new automation
      • Get a single automation
      • Update an automation
      • Delete an automation (soft delete)
    • Automation Steps
      • List steps for an automation
      • Create a new step in an automation
      • Reorder automation steps
      • Get a single automation step
      • Update an automation step
      • Delete an automation step
    • Automation Queue
      • Create queue entries for matching automations
      • Start pending queues
      • Process active queues
  • Reports
    • Mobile App
      • Dashboard
      • Loads Screen
    • Web App
      • Dashboard
  • Jobs
    • Create Work Order
    • List Work Orders
    • Get Work Order
    • Update Work Order
    • Delete Work Order
    • Assign Work Order
    • Dispatch Work Order
    • Update Status
  • Catalog
    • Services
      • List services (defaults + company)
      • Create a company default service
      • Get a service by UUID
      • Update a company service
      • Delete a company service
      • Import a JSON default into the company services list (optional)
  • Schemas
    • WorkOrder
    • Automation
    • NotFound
    • Service
    • Unauthorized
    • AutomationCreate
    • ValidationError
    • ServiceCreateRequest
    • Forbidden
    • AutomationUpdate
    • ServiceUpdateRequest
    • AutomationStep
    • ImportDefaultRequest
    • AutomationStepCreate
    • ErrorResponse
    • AutomationStepUpdate
    • AutomationQueue
  1. templates

Template Preview

Developing
POST
/templates/00000000-0000-0000-0000-000000000101/preview
Last modified:2025-12-31 16:21:51

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params

Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST 'https://connect.dispatchable.com/documents/api/v1/templates/00000000-0000-0000-0000-000000000101/preview' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "uuid": "00000000-0000-0000-0000-000000000101",
    "type": "load",
    "data": {
        "uuid": "7c16db3f-bb9b-4d6d-9825-f26490a51dc1",
        "company_uuid": "fd8ddd84-420d-4db1-ba17-c1d8b62434a7",
        "user_uuid": "9266be0e-d1a7-4ae6-a4c1-63aa281aaa05",
        "assigned_to": "9266be0e-d1a7-4ae6-a4c1-63aa281aaa05",
        "external_id": null,
        "internal_id": 1339,
        "is_active": 1,
        "status": "active",
        "lifecycle": "lead",
        "origin_city": null,
        "origin_state": null,
        "origin_zip": null,
        "origin_address_1": null,
        "origin_address_2": null,
        "origin_contact": null,
        "origin_phone_1": null,
        "origin_phone_2": null,
        "origin_phone_3": null,
        "buyer_number": null,
        "origin_mobile": null,
        "origin_name": null,
        "origin_instructions": null,
        "destination_city": null,
        "destination_state": null,
        "destination_zip": null,
        "destination_address_1": null,
        "destination_address_2": null,
        "destination_contact": null,
        "destination_phone_1": null,
        "destination_phone_2": null,
        "destination_phone_3": null,
        "destination_mobile": null,
        "destination_name": null,
        "destination_instructions": null,
        "is_touch_free": 0,
        "trailer_type": "DRY_VAN",
        "load_type": "ltl",
        "first_avail": null,
        "load_date": null,
        "load_terms": null,
        "delivery_date": null,
        "delivery_terms": null,
        "carrier_pay": null,
        "carrier_status": "unassigned",
        "cod_amount": null,
        "additional_info": null,
        "additional_terms": null,
        "special_instructions": null,
        "notes_from_customer": null,
        "total": "222.00",
        "payment_method": null,
        "broker_fee": null,
        "shipper_name": null,
        "shipper_address": null,
        "shipper_phone": null,
        "shipper_email": null,
        "shipper_status": "untouched",
        "load_length": null,
        "load_width": null,
        "load_height": null,
        "load_weight": null,
        "load_pieces": null,
        "load_unit": null,
        "load_description": null,
        "load_value": null,
        "load_value_currency": null,
        "load_payment_term": null,
        "load_payment_term_details": null,
        "driver_instructions": null,
        "driver_instructions_details": null,
        "inspection_details": null,
        "inspection_type": null,
        "shipper_token": null,
        "shipper_token_expires_at": null,
        "carrier_token": null,
        "carrier_token_expires_at": null,
        "next_follow_up": null,
        "is_responsive": 1,
        "parent_uuid": null,
        "load_name": null,
        "driver_pay": null,
        "data_source_name": null,
        "data_source_uuid": null,
        "utm_source": null,
        "utm_medium": null,
        "utm_campaign": null,
        "utm_term": null,
        "utm_content": null,
        "load_hours_from": null,
        "load_hours_to": null,
        "needs_load_appointment": false,
        "needs_driver_call_ahead_load": false,
        "needs_load_appt_scheduled": false,
        "pickup_ref_no": null,
        "shipper_load_method": null,
        "origin_contact_email": null,
        "delivery_hours_from": null,
        "delivery_hours_to": null,
        "needs_delivery_appointment": false,
        "needs_driver_call_ahead_delivery": false,
        "needs_delivery_appt_scheduled": false,
        "delivery_ref_no": null,
        "shipper_delivery_method": null,
        "destination_contact_email": null,
        "balance_payment_method": null,
        "balance_payment_time": null,
        "balance_payment_terms_begin_on": null,
        "cod_cop_location": null,
        "origin_notes": null,
        "delivery_notes": null,
        "cash_on_delivery": null,
        "billing_notes": null,
        "customer_company": "Cronetic Technologies LLC",
        "customer_first_name": "Peanut",
        "customer_last_name": "Burnt",
        "customer_street_address_1": "15325 SW 89 Ave",
        "customer_street_address_2": null,
        "customer_city": "Miami",
        "customer_state": null,
        "customer_zip": "33157",
        "customer_phone_1": "8882457459",
        "customer_phone_2": null,
        "customer_email": "stancepro1@aaa.com",
        "tracking_number": null,
        "created_at": "2025-12-11T21:18:44.000000Z",
        "updated_at": "2025-12-12T05:13:51.000000Z",
        "deleted_at": null,
        "commodities": [
            {
                "id": 10,
                "uuid": "76fb41c2-b855-4f38-89d5-daa764e7dbc8",
                "company_uuid": "fd8ddd84-420d-4db1-ba17-c1d8b62434a7",
                "load_uuid": "7c16db3f-bb9b-4d6d-9825-f26490a51dc1",
                "created_by": "9266be0e-d1a7-4ae6-a4c1-63aa281aaa05",
                "name": "bottles",
                "description": null,
                "package_type": "PALLET_48x40",
                "quantity": 1,
                "is_new": 1,
                "is_fragile": 0,
                "is_trade_show": 0,
                "is_hazardous": 0,
                "contains_hazardous_material": 0,
                "length_in": "48.00",
                "width_in": "40.00",
                "height_in": "123.00",
                "weight_lbs": "1.00",
                "nmfc_code": null,
                "freight_class": null,
                "is_stackable": null,
                "is_forkliftable": null,
                "requires_tarps": null,
                "requires_reefer": null,
                "temp_min_f": null,
                "temp_max_f": null,
                "is_hazmat": false,
                "hazmat_un_number": null,
                "hazmat_proper_name": null,
                "hazmat_class": null,
                "hazmat_packing_group": null,
                "declared_value": null,
                "currency": "USD",
                "shipping_cost": "222.00",
                "deposit": "1.00",
                "chains": 4,
                "straps": 0,
                "created_at": "2025-12-11T21:21:52.000000Z",
                "updated_at": "2025-12-11T21:21:52.000000Z",
                "deleted_at": null
            }
        ]
    }
}'
Response Response Example
{}
Modified at 2025-12-31 16:21:51
Previous
Delete
Next
Template Preview Raw