Create a new dispatch

1min

POST
Asynchronous API for creating a new dispatch by specifying the following parameters in the request body: |  Parameter   |   Description  |   Type    |   Validation  |
|---  |---  |---  |  ---  |
|  dispatchRef*   | External dispatch reference.    |   string  |  minLength: 4 maxLength: 36    |
|  jobs   | Jobs to be completed in this dispatch.  |    |   |
|  ㅤ↳JobId   |  Job ID.   |  string   |   minLength: 1 maxLength: 64 |
|  participants  | Participants to be added in this dispatch.    |     |     |
|  ㅤ↳ParticipantId   |  Participant ID   |  string   |   minLength: 1 maxLength: 64 |
*This is required.
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.
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
*
﻿
﻿

Code	Description
200 - OK	Everything worked as expected.
400 - Bad Request	The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized	No valid API key provided.

Updated 03 Aug 2023

Did this page help you?

Get configuration of a dispatch type

Update all the values of custom data for a dispatch