Remove a participant from dispatch

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
dispatchId
DispatchId
*
Dispatch ID.
participantId
ParticipantId
*
Participant ID.
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
object
*
Remove job from an existing dispatch
_event_meta
Meta
onRequest
CustomCallRequestObject
onError
CustomCallErrorObject
callback
CallbackObject
RESPONSES
200
OK
SuccessResponse
error
Error
*
Error information
request
Request
*
data
object
Example: [object Object]
400
Error Occurred
DeleteErrorResponse
error
Error
*
Error information
request
Request
*
401
Error Occurred
DeleteErrorResponse
error
Error
*
Error information
request
Request
*
404
Error Occurred
DeleteErrorResponse
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.
404 - Not Found	The requested resource doesn't exist.

Updated 03 Aug 2023

Did this page help you?

Add multiple participants to a dispatch

Change status and subStatus of a dispatch by ref