Dispatch Service
Dispatch

Remove a participant from dispatch by ref

1min
DELETE

API for removing a job from an existing dispatch: | Header/Path | Description | Type |
|--- |--- |--- |
| X-COREOS-REQUEST-ID* (header) | Unique request ID. | string | | X-USER-ID* (header) | User ID. | string | | X-USER-NAME* (header) | User name. | string | | jobId* (path) | Job ID. | string | | dispatchId* (path) | Dispatch ID. | string | *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
*
participantId
*
Header Parameters
X-COREOS-REQUEST-ID
*
X-COREOS-TID
*
X-COREOS-ACCESS
*
X-COREOS-USERINFO
*
X-COREOS-CALLBACK-SECRET
Body Parameters
body
*
Description
Remove job from an existing dispatch
_event_meta
onRequest
onError
callback
Responses
200
OK
error
*
request
*
data
400
Error Occurred
error
*
request
*
401
Error Occurred
error
*
request
*
404
Error Occurred
error
*
request
*
Curl
JS
Ruby
Python
Responses
200
400
401
404