Genesys

Genesys Task Management API

Task Management

GitHub OpenAPI

Operations 76

GET /api/v2/taskmanagement/workitems/bulk/jobs/users/me Get bulk jobs created by the currently logged in user. #
GET /api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId} Get the bulk add job associated with the job id. #
DELETE /api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId} Delete a bulk add job #
PATCH /api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId} Update workitem bulk add job. #
GET /api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}/results Get bulk add job results. #
POST /api/v2/taskmanagement/workitems/bulk/add/jobs Create a workitem bulk add job. #
GET /api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId}/results Get bulk terminate job results. #
GET /api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId} Get the bulk job associated with the job id. #
DELETE /api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId} Delete a Bulk job #
PATCH /api/v2/taskmanagement/workitems/bulk/terminate/jobs/{bulkJobId} Update workitem bulk terminate job. #
POST /api/v2/taskmanagement/workitems/bulk/terminate/jobs Create a workitem bulk terminate job. #
POST /api/v2/taskmanagement/workbins/query Query for workbins #
GET /api/v2/taskmanagement/workbins/{workbinId} Get a workbin #
DELETE /api/v2/taskmanagement/workbins/{workbinId} Delete a workbin #
PATCH /api/v2/taskmanagement/workbins/{workbinId} Update the attributes of a workbin #
GET /api/v2/taskmanagement/workbins/{workbinId}/versions Get all versions of a workbin #
GET /api/v2/taskmanagement/workbins/{workbinId}/versions/{entityVersion} Get a version of a workbin #
GET /api/v2/taskmanagement/workbins/{workbinId}/history Get a listing of a workbin's attribute change history #
POST /api/v2/taskmanagement/workbins Create a workbin #
POST /api/v2/taskmanagement/workitems Create a workitem #
POST /api/v2/taskmanagement/workitems/query Query for workitems #
POST /api/v2/taskmanagement/workitems/query/jobs Create a workitem query job #
GET /api/v2/taskmanagement/workitems/query/jobs/{jobId} Get the workitem query job associated with the job id. #
GET /api/v2/taskmanagement/workitems/query/jobs/{jobId}/results Get results from for workitem query job #
POST /api/v2/taskmanagement/workitems/{workitemId}/disconnect Disconnect the assignee of the workitem #
POST /api/v2/taskmanagement/workitems/{workitemId}/terminate Terminate a workitem #
GET /api/v2/taskmanagement/workitems/{workitemId} Get a workitem #
DELETE /api/v2/taskmanagement/workitems/{workitemId} Delete a workitem #
PATCH /api/v2/taskmanagement/workitems/{workitemId} Update the attributes of a workitem #
PATCH /api/v2/taskmanagement/workitems/{workitemId}/assignment Attempts to manually assign a specified workitem to a specified user. Ignores bullseye ring, PAR score, skills, and languages. #
GET /api/v2/taskmanagement/workitems/{workitemId}/versions Get all versions of a workitem #
GET /api/v2/taskmanagement/workitems/{workitemId}/versions/{entityVersion} Get a version of a workitem #
GET /api/v2/taskmanagement/workitems/{workitemId}/history Get a listing of a workitem's attribute change history #
POST /api/v2/taskmanagement/workitems/{workitemId}/acd/cancel Cancel the assignment process for a workitem that is currently queued for assignment through ACD. #
GET /api/v2/taskmanagement/workitems/schemas/coretypes/{coreTypeName} Get a specific named core type. #
GET /api/v2/taskmanagement/workitems/schemas/coretypes Get the core types from which all schemas are built. #
GET /api/v2/taskmanagement/workitems/schemas/limits Get quantitative limits on schemas #
GET /api/v2/taskmanagement/workitems/schemas/{schemaId} Get a schema #
PUT /api/v2/taskmanagement/workitems/schemas/{schemaId} Update a schema #
DELETE /api/v2/taskmanagement/workitems/schemas/{schemaId} Delete a schema #
GET /api/v2/taskmanagement/workitems/schemas/{schemaId}/versions/{versionId} Get a specific version of a schema #
GET /api/v2/taskmanagement/workitems/schemas/{schemaId}/versions Get all versions of a schema #
GET /api/v2/taskmanagement/workitems/schemas Get a list of schemas. #
POST /api/v2/taskmanagement/workitems/schemas Create a schema #
GET /api/v2/taskmanagement/workitems/{workitemId}/users/{userId}/wrapups Get all wrapup codes added for the given user for a workitem. #
PATCH /api/v2/taskmanagement/workitems/{workitemId}/users/{userId}/wrapups Add/Remove a wrapup code for a given user in a workitem. #
PATCH /api/v2/taskmanagement/workitems/{workitemId}/users/me/wrapups Add/Remove a wrapup code for the current user in a workitem. #
GET /api/v2/taskmanagement/workitems/{workitemId}/wrapups Get all wrapup codes added for all users for a workitem. #
GET /api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId} Get a status #
DELETE /api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId} Delete a status #
PATCH /api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId} Update the attributes of a status #
GET /api/v2/taskmanagement/worktypes/{worktypeId}/statuses Get list of statuses for this worktype. #
POST /api/v2/taskmanagement/worktypes/{worktypeId}/statuses Add a status to a worktype #
POST /api/v2/taskmanagement/worktypes/query Query for worktypes #
GET /api/v2/taskmanagement/worktypes/{worktypeId} Get a worktype #
DELETE /api/v2/taskmanagement/worktypes/{worktypeId} Delete a worktype #
PATCH /api/v2/taskmanagement/worktypes/{worktypeId} Update the attributes of a worktype #
GET /api/v2/taskmanagement/worktypes/{worktypeId}/versions Get all versions of a worktype #
GET /api/v2/taskmanagement/worktypes/{worktypeId}/versions/{entityVersion} Get a version of a worktype #
GET /api/v2/taskmanagement/worktypes/{worktypeId}/history Get a listing of a worktype's attribute change history #
POST /api/v2/taskmanagement/worktypes Create a worktype #
GET /api/v2/taskmanagement/worktypes/{worktypeId}/flows/datebased/rules/{ruleId} Get a date based rule #
DELETE /api/v2/taskmanagement/worktypes/{worktypeId}/flows/datebased/rules/{ruleId} Delete a date based rule #
PATCH /api/v2/taskmanagement/worktypes/{worktypeId}/flows/datebased/rules/{ruleId} Update the attributes of a date based rule #
GET /api/v2/taskmanagement/worktypes/{worktypeId}/flows/datebased/rules Get all date based rules for a worktype #
POST /api/v2/taskmanagement/worktypes/{worktypeId}/flows/datebased/rules Add a date based rule to a worktype #
GET /api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId} Get an attribute change rule #
DELETE /api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId} Delete a rule #
PATCH /api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules/{ruleId} Update the attributes of a rule #
GET /api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules Get all attribute-change rules for a worktype #
POST /api/v2/taskmanagement/worktypes/{worktypeId}/flows/onattributechange/rules Add an attribute-change rule to a worktype #
GET /api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId} Get an on-create rule #
DELETE /api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId} Delete a rule #
PATCH /api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules/{ruleId} Update the attributes of a rule #
GET /api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules Get all on-create rules for a worktype #
POST /api/v2/taskmanagement/worktypes/{worktypeId}/flows/oncreate/rules Add an on-create rule to a worktype #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/authentication/genesys-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-task-management-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/scopes/genesys-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/conventions/genesys-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/errors/genesys-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/data-model/genesys-data-model.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/agentic-access/genesys-agentic-access.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/genesys-task-management-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

genesys-task-management-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
  version: v2
  title: PureCloud Platform Agent Assistants Task Management API
  termsOfService: https://help.genesys.cloud/articles/terms-and-conditions/
  contact:
    name: PureCloud Developer Evangelists
    url: https://developer.genesys.cloud/
    email: DeveloperEvangelists@genesys.com
  license:
    name: UNLICENSED
    url: https://help.genesys.cloud/articles/terms-and-conditions/
servers:
- url: https://api.mypurecloud.com
tags:
- name: Task Management
  description: Task Management
paths:
  /api/v2/taskmanagement/workitems/bulk/jobs/users/me:
    get:
      tags:
      - Task Management
      summary: Get bulk jobs created by the currently logged in user.
      description: ''
      operationId: getTaskmanagementWorkitemsBulkJobsUsersMe
      parameters:
      - name: after
        in: query
        description: The cursor that points to the end of the set of entities that has been returned.
        required: false
        schema:
          type: string
      - name: pageSize
        in: query
        description: Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200.
        required: false
        schema:
          type: integer
          format: int32
          default: 25
      - name: sortOrder
        in: query
        description: Ascending or descending sort order
        required: false
        schema:
          type: string
          enum:
          - ascending
          - descending
          default: descending
      - name: action
        in: query
        description: The bulk job action.
        required: false
        schema:
          type: string
          enum:
          - TerminateWorkitems
          - AddWorkitems
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkJobsListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '401':
          description: No authentication bearer token specified in authorization header.
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: You are not authorized to perform the requested action.
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: The requested resource was not found.
          x-inin-error-codes:
            not.found: The requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '409':
          description: The request conflicts with the current state of the target resource.
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '504':
          description: The request timed out.
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - PureCloud OAuth:
        - workitems
        - workitems:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - workitems:bulkJob:view
      x-purecloud-method-name: getTaskmanagementWorkitemsBulkJobsUsersMe
  /api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}:
    get:
      tags:
      - Task Management
      summary: Get the bulk add job associated with the job id.
      description: ''
      operationId: getTaskmanagementWorkitemsBulkAddJob
      parameters:
      - name: bulkJobId
        in: path
        description: Bulk job id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkJob'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '401':
          description: No authentication bearer token specified in authorization header.
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: You are not authorized to perform the requested action.
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: The requested resource was not found.
          x-inin-error-codes:
            not.found: Bulk add job with the specified ID was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '409':
          description: The request conflicts with the current state of the target resource.
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '504':
          description: The request timed out.
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - PureCloud OAuth:
        - workitems
        - workitems:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - workitems:bulkAddJob:view
      x-purecloud-method-name: getTaskmanagementWorkitemsBulkAddJob
    delete:
      tags:
      - Task Management
      summary: Delete a bulk add job
      description: ''
      operationId: deleteTaskmanagementWorkitemsBulkAddJob
      parameters:
      - name: bulkJobId
        in: path
        description: Bulk job id
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Bulk add job successfully deleted.
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '401':
          description: No authentication bearer token specified in authorization header.
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: You are not authorized to perform the requested action.
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: The requested resource was not found.
          x-inin-error-codes:
            not.found: The requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '409':
          description: The request conflicts with the current state of the target resource.
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '504':
          description: The request timed out.
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - PureCloud OAuth:
        - workitems
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - workitems:bulkAddJob:delete
      x-purecloud-method-name: deleteTaskmanagementWorkitemsBulkAddJob
    patch:
      tags:
      - Task Management
      summary: Update workitem bulk add job.
      description: ''
      operationId: patchTaskmanagementWorkitemsBulkAddJob
      parameters:
      - name: bulkJobId
        in: path
        description: Bulk job id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkJob'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
            service.limit.bulk.jobs.concurrent.maximum.limit.reached: The maximum number of concurrent active bulk jobs has been reached.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '401':
          description: No authentication bearer token specified in authorization header.
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: You are not authorized to perform the requested action.
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: The requested resource was not found.
          x-inin-error-codes:
            not.found: The requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '409':
          description: The request conflicts with the current state of the target resource.
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '504':
          description: The request timed out.
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - PureCloud OAuth:
        - workitems
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - workitems:bulkAddJob:edit
      x-purecloud-method-name: patchTaskmanagementWorkitemsBulkAddJob
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkJobUpdate'
        description: Bulk add job update request
        required: true
  /api/v2/taskmanagement/workitems/bulk/add/jobs/{bulkJobId}/results:
    get:
      tags:
      - Task Management
      summary: Get bulk add job results.
      description: ''
      operationId: getTaskmanagementWorkitemsBulkAddJobResults
      parameters:
      - name: bulkJobId
        in: path
        description: Bulk job id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkJobAddResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '401':
          description: No authentication bearer token specified in authorization header.
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: You are not authorized to perform the requested action.
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are m

# --- truncated at 32 KB (711 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-task-management-api-openapi.yml