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
*
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-USERINFO
string
*
X-COREOS-CALLBACK-SECRET
string
Body Parameters
body
DispatchRequest
*
Description
Create a new dispatch
dispatchRef
string
dispatchTypeName
string
dispatchTypeId
string
*
jobs
JobId[]
participants
ParticipantId[]
customData
CustomData
_event_meta
Meta
onRequest
CustomCallRequestObject
onError
CustomCallErrorObject
callback
CallbackObject
Responses
202
OK
SuccessResponse
error
Error
*
request
Request
*
data
object
400
Error Occurred
ErrorResponse
error
Error
*
request
Request
*
401
Error Occurred
ErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff 'https://{domain}/core/api/v2/dispatch-service/dispatches' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "dispatchTypeId": "",
  "onRequest": {
    "url": "",
    "requestHeader": {},
    "requestBody": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  },
  "onError": {
    "url": "",
    "requestHeader": {},
    "requestBody": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  }
}'
curl --location --globoff 'https://{domain}/core/api/v2/dispatch-service/dispatches' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "dispatchTypeId": "",
  "onRequest": {
    "url": "",
    "requestHeader": {},
    "requestBody": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  },
  "onError": {
    "url": "",
    "requestHeader": {},
    "requestBody": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  }
}'
Responses
202
400
401
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
// OK 
{
  "error": {
    "code": "",
    "description": "",
    "additionalInfo": {}
  },
  "request": {
    "uri": "",
    "method": "",
    "queryString": "",
    "body": {}
  },
  "data": {
    "id": ""
  }
}
﻿
﻿

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