How to: Manage Job Type

For information about prerequisites, see Integrate with Dispatch.

Create a Job Type

To create a Job Type, call the Create Job Type endpoint and pass the following members in the request body:

nameName of the Job Type.string
Pattern: [a-zA-Z]{4,16}$
_event_meta (optional)Metadata for the Job Type.

Your JSON request body should be similar to the following:

  "name": "TestJobType",
  "_event_meta": {}

Retrieve existing Job Types

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