Remove multiple jobs from a dispatch by ref

1min

DELETE
API for removing multiple jobs to an existing dispatch: |  Parameter   |   Description  |   Type    |   Validation  |
|---  |---  |---  |  ---  |
|  jobs*   | List of Job IDs.    |   array  |  minLength: 1 |
*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
DispatchRef
*
Dispatch Ref
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 multiple jobs from an existing dispatch
jobs
JobId[]
*
_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
PostErrorResponse
error
Error
*
Error information
request
Request
*
401
Error Occurred
PostErrorResponse
error
Error
*
Error information
request
Request
*
404
Error Occurred
PostErrorResponse
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 jobs to a dispatch by ref

Remove a job from dispatch by ref