Website logo
Docs
API Reference
Postman Collection
Release Notes
Navigate through spaces
⌘K
Overview
API Reference Overview
How to use the API 'Try It' feature
Authentication And Authorization (AAA) Service
Role Management
User Management
Authentication
Connection Management
Group Management
Participant Service
Tenant
Participant Type
Participant Type - Custom Code Config
Participant Type - Attributes Config
Participant Type - State Machine
Participant
Templates
Participant State
Participant - Batch Processing
Container Service
Container Type
Container Type - Custom Code Config
Container Type - Attributes Config
Container Type - State Machine Config
Container
Container State
Container Group
Container - Batch Processing
Dispatch Service
Job Type
Job Workflow
Job
Job - Config
Dispatch Type
Dispatch
Mobile APIs
Dispatch - Config
Ledger
Ledger in batch
Custom Code Config
Workflow Service
Execution Task
Changelog
Execution Macro
Execution Workflow
Execution Workflow Instance
Health Check
SDS Service
App
Vault
Data
File Management Service
Folders
Files
State Machine Service
State Machine Config
Entity
Events
Reasons
Instance State
Movement Tracking Service
Trace Data
Missing Sequence Numbers
Snapped Distance
IOT Device
Geofence
MTS Subscription
Entity Service
Entity Type
State Machine Config
Entity Instance
Entity Type - Custom Code Config
Entity Instance State
Templates
Entity - Batch Processing
Notification Service
App Notification
Filter
Event
Change Log
Location Service
Location
Country
State
City
Search
Order Service
Order Config
Order State Machine Configuration
Order State Machine Transition
Work Order State Machine Configuration
Work Order State Transition
Order
Batch Order
Custom Code Config
Plugin Callback
External Reference APIs
Work Order Config
Work Order Status
Plugins
PluginWorkflow
Address Service
Address Config
Address
User FPA
Users
Facility FPA
Facilities
Vehicle FPA
Vehicles
LogisticsOrder API
Order
Batch Order
AAA - External Authorizer
Authorization
Orchestrator
Plugins
PluginWorkflow
Rules
Get Entity Status
DLQ Service
Query & Listing
Default Plugins
Job Manager
Work Order Manager
Container Manager
Workflow Manager
Cancellation Manager
Scheduler Service
Scheduler Service
Docs powered by Archbee
Dispatch Service
Dispatch

Update all the values of custom data for a dispatch by ref

1min
PUT

API for updating the custom data of an existing dispatch:

HTTP Status Code Summary

CodeDescription
200 - OKEverything worked as expected.
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedNo valid API key provided.
404 - Not FoundThe requested resource doesn't exist.
PATH PARAMETERS
dispatchRef
DispatchRef
*
Dispatch Ref
HEADER PARAMETERS
X-COREOS-REQUEST-ID
string
*
Unique RequestId
X-COREOS-TID
string
*
Tenant id
X-COREOS-ACCESS
string
*
Access Token
X-COREOS-USERINFO
string
*
user info
X-COREOS-CALLBACK-SECRET
string

callback secret (base64 encoded string)

BODY PARAMETERS
body
CustomDataUpdate
*
Update custom data request
customData
object
*
Example: [object Object]
_event_meta
Meta
Meta data
onRequest
CustomCallRequestObject
onError
CustomCallErrorObject
callback
CallbackObject
RESPONSES
200
OK
SuccessResponse
error
Error
*
Error information
request
Request
*
data
object
Example: [object Object]
400
Error Occurred
PostErrorResponse
error
Error
*
Error information
request
Request
*
401
Error Occurred
PostErrorResponse
error
Error
*
Error information
request
Request
*
404
Error Occurred
PostErrorResponse
error
Error
*
Error information
request
Request
*




Updated 03 Aug 2023
Did this page help you?
PREVIOUS
Remove a participant from dispatch by ref
NEXT
Update some values of custom data for a dispatch by ref
Docs powered by Archbee