Dispatch Service
Dispatch
Create a new dispatch
1min
POST
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
DispatchRequest
*Create a new dispatch
dispatchRef
string
External dispatch reference
dispatchTypeName
string
Dispatch Type Name
dispatchTypeId
string
*Dispatch Type Id
jobs
JobId[]
Jobs to be completed in this dispatch
participants
ParticipantId[]
Participants to be added in this dispatch
customData
CustomData
Custom data based on type
_event_meta
Meta
Meta data
onRequest
CustomCallRequestObject
onError
CustomCallErrorObject
callback
CallbackObject
RESPONSES
202
OK
SuccessResponse
error
Error
*Error information
request
Request
*data
object
Example: [object Object]
400
Error Occurred
ErrorResponse
error
Error
*Error information
request
Request
*401
Error Occurred
ErrorResponse
error
Error
*Error information
request
Request
*
Updated 03 Aug 2023
Did this page help you?