Dispatchable
  1. Automation Steps
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
      GET
    • Store
      POST
    • Read
      GET
    • Update
      PUT
    • Delete
      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
      • Create Template
      • Read
      • Update
      • Delete
      • Template Preview
      • Template Preview Raw
    • 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
    • Create
    • Read
    • Update
    • Send
    • Delete
    • Test
  • 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
        GET
      • Create a new step in an automation
        POST
      • Reorder automation steps
        POST
      • Get a single automation step
        GET
      • Update an automation step
        PUT
      • Delete an automation step
        DELETE
    • 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. Automation Steps

Create a new step in an automation

POST
/automations/{uuid}/steps
Last modified:2026-02-17 18:57:15
Creates a step. If step_number is omitted, appends to end. If provided, existing steps are shifted to make room.

Request

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

Header Params

Body Params application/json

Examples

Responses

🟢201Created
application/json
Step created
Body

🟠404Record Not Found
🟠422Parameter Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://connect.dispatchable.com/automations/api/v1/automations//steps' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "step_app": "email",
    "step_name": "Send dispatch notification",
    "step_type": "string",
    "step_description": "string",
    "step_number": 1
}'
Response Response Example
201 - Example 1
{
    "data": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "company_uuid": "aba69bec-94b3-48e8-9737-4f951465d0f8",
        "automation_id": 0,
        "step_number": 0,
        "step_app": "email",
        "step_name": "Send dispatch notification",
        "step_type": "string",
        "step_description": "string",
        "step_trigger": "string",
        "relation_operator": "string",
        "step_trigger_value": "string",
        "step_action": "string",
        "step_action_value": "string",
        "created_at": "2019-08-24T14:15:22.123Z",
        "updated_at": "2019-08-24T14:15:22.123Z"
    },
    "message": "string",
    "success": true
}
Modified at 2026-02-17 18:57:15
Previous
List steps for an automation
Next
Reorder automation steps