Dispatch Service
Dispatch

Change status and subStatus of a dispatch by ref

1min
POST

API for changing status and subStatus of an existing dispatch: | Parameter | Description | Type | Validation | |--- |--- |--- | --- | | status* | status. | string | minLength: 1 maxLength: 64 | | subStatus | subStatus. | 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.
404 - Not FoundThe requested resource doesn't exist.
Path Parameters
dispatchRef
*
Header Parameters
X-COREOS-REQUEST-ID
*
X-COREOS-TID
*
X-COREOS-ACCESS
*
X-COREOS-USERINFO
*
X-COREOS-CALLBACK-SECRET
Body Parameters
body
*
Description
Change status
status
*
subStatus
_event_meta
onRequest
onError
callback
Responses
202
OK
error
*
request
*
data
400
Error Occurred
error
*
request
*
401
Error Occurred
error
*
request
*
404
Error Occurred
error
*
request
*
Curl
JS
Ruby
Python
Responses
202
400
401
404