How to: Manage Dispatch Type

For information about prerequisites, see Integrate with Dispatch.

Create a Dispatch Type

To create a Dispatch Type, call the Create Dispatch Type endpoint and pass the following required member in the request body:

Member	Description	Remarks
`name`	Name of the Dispatch Type.	string pattern: ^[a-zA-Z]{4,16}$

The JSON request body should be similar to the following:

{
  "name": "string",
  "_event_meta": {}
}

Retrieve existing Dispatch Types

To retrieve the list of existing Dispatch Types, call the Get all Dispatch Types endpoint. If you want to retrieve a particular Dispatch Type, call the Get Dispatch Type endpoint and specify the dispatchTypeId in the path parameter.