post https://{base_url}/core/api/v1/dispatch-service/dispatches
Asynchronous API for creating a new dispatch by specifying the following parameters in the request body: | Parameter | Description | Type |
---|---|---|---|
dispatchRef * | External dispatch reference. | string | minLength: 4 maxLength: 36 |
jobs | Jobs to be completed in this dispatch. | ||
ㅤ↳JobId | Job ID. | string | minLength: 1 maxLength: 64 |
participants | Participants to be added in this dispatch. | ||
ㅤ↳ParticipantId | Participant ID | string | minLength: 1 maxLength: 64 |
*This is required.
HTTP Status Code Summary
| 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. |