Add participant to a dispatch

1min

PATCH
API for adding a participant to an existing dispatch: |  Parameter   |   Description  |   Type    |   Validation  |
|---  |---  |---  |  ---  |
|  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.
404 - Not FoundThe requested resource doesn't exist.
Path Parameters
dispatchId
DispatchId
*
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
object
*
Description
Add a participant to an existing dispatch
participantId
ParticipantId
*
callback
Callback
_event_meta
Meta
onRequest
CustomCallRequestObject
onError
CustomCallErrorObject
Responses
200
OK
SuccessResponse
error
Error
*
request
Request
*
data
object
400
Error Occurred
PostErrorResponse
error
Error
*
request
Request
*
401
Error Occurred
PostErrorResponse
error
Error
*
request
Request
*
404
Error Occurred
PostErrorResponse
error
Error
*
request
Request
*
Curl
JS
Ruby
Python
curl --location --globoff --request PATCH 'https://{domain}/core/api/v2/dispatch-service/dispatches/{dispatchId}/participants' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "participantId": "",
  "callback": {
    "url": ""
  },
  "onRequest": {
    "url": "",
    "requestHeader": {},
    "requestBody": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  },
  "onError": {
    "url": "",
    "requestHeader": {},
    "requestBody": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  }
}'
curl --location --globoff --request PATCH 'https://{domain}/core/api/v2/dispatch-service/dispatches/{dispatchId}/participants' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
  "participantId": "",
  "callback": {
    "url": ""
  },
  "onRequest": {
    "url": "",
    "requestHeader": {},
    "requestBody": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  },
  "onError": {
    "url": "",
    "requestHeader": {},
    "requestBody": {},
    "method": "",
    "onResponse": {
      "wait": false
    }
  }
}'
Responses
200
400
401
404
// 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.
404 - Not Found	The requested resource doesn't exist.

Updated 03 Aug 2023

Did this page help you?

Update job within dispatch on receiving acknowledgment

Add multiple participants to a dispatch