> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Stop Batch Job

> Stop a batch job based on Id.

NsApiSlow threshold: 3000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-BatchAgent.json post /api/v1/Agents/Batch/StopBatchJob
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - BatchAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Agents/Batch/StopBatchJob:
    post:
      tags:
        - Batch_Agent
      summary: Stop Batch Job
      description: |-
        Stop a batch job based on Id.

        NsApiSlow threshold: 3000 ms.
      operationId: v1BatchAgent_StopBatchJob
      parameters:
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category". Default = show all fields.
          required: false
          schema:
            type: string
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.BatchCarriers.StopBatchJobRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.BatchCarriers.StopBatchJobRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.BatchCarriers.StopBatchJobRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.BatchCarriers.StopBatchJobRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.BatchCarriers.StopBatchJobRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.BatchCarriers.StopBatchJobRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.BatchCarriers.StopBatchJobRequest
        description: Id
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: boolean
            text/json:
              schema:
                type: boolean
            application/xml:
              schema:
                type: boolean
            text/xml:
              schema:
                type: boolean
            application/json-patch+json:
              schema:
                type: boolean
            application/merge-patch+json:
              schema:
                type: boolean
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.BatchCarriers.StopBatchJobRequest:
      description: 'StopBatchJob: Stop a batch job based on Id.'
      type: object
      properties:
        Id:
          format: int32
          type: integer

````

## Related topics

- [Stop Batch Job](/en/api/reference/restful/rest/batch/stop-batch-job.md)
- [SuperOffice.WebApi.Data.Batch StopBatchJobRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Batch_StopBatchJobRequest.md)
- [NSBatchAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSBatchAgent.md)
- [SuperOffice.WebApi.Agents.BatchAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.BatchAgent.md)
- [SuperOffice.WebApi.Agents.IBatchAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IBatchAgent.md)
- [Start Batch Job](/en/api/reference/restful/rest/batch/start-batch-job.md)