> ## Documentation Index > Fetch the complete documentation index at: https://doc.extole.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a batch job > Updates the mutable fields of an existing batch job: `name`, `tags`, and `scopes`. The job must not be in a terminal state (`DONE`, `FAILED`, `CANCELED`, or `EXPIRED`). Data source, event name, and column mappings are immutable after creation. ## OpenAPI ````yaml /api-reference/integration-server-to-extole.json put /v6/batches/{batchId} openapi: 3.0.1 info: description: >- Server-to-Extole integration endpoints: event submission, person lookup, zone rendering, token management, and reward retrieval for backend services authenticating with client credentials. title: Integration API - Server to Extole version: '1.0' servers: - description: Production url: https://api.extole.io security: - HEADER: [] - QUERY: [] - COOKIE: [] tags: - name: Authentication - name: Batch Jobs - name: Events - name: Files - name: Persons - name: Reward Suppliers - name: Rewards - name: SFTP Servers - name: Zone Rendering paths: /v6/batches/{batchId}: put: tags: - Batch Jobs summary: Update a batch job description: >- Updates the mutable fields of an existing batch job: `name`, `tags`, and `scopes`. The job must not be in a terminal state (`DONE`, `FAILED`, `CANCELED`, or `EXPIRED`). Data source, event name, and column mappings are immutable after creation. operationId: updateBatch parameters: - description: Batch job ID. in: path name: batchId required: true schema: type: string requestBody: content: application/json: example: name: name scopes: - CLIENT_ADMIN tags: - tag schema: $ref: '#/components/schemas/BatchJobUpdateRequest' responses: '200': description: Batch job updated. Returns the full updated job record. '400': content: application/json: examples: batch_job_data_source_empty: $ref: '#/components/examples/batch_job_data_source_empty' batch_job_delete_not_allowed: $ref: '#/components/examples/batch_job_delete_not_allowed' batch_job_event_name_invalid: $ref: '#/components/examples/batch_job_event_name_invalid' batch_job_invalid_state_transition: $ref: '#/components/examples/batch_job_invalid_state_transition' batch_job_name_invalid: $ref: '#/components/examples/batch_job_name_invalid' batch_job_tag_invalid: $ref: '#/components/examples/batch_job_tag_invalid' batch_job_unauthorized_scopes: $ref: '#/components/examples/batch_job_unauthorized_scopes' binding_error: $ref: '#/components/examples/binding_error' invalid_json: $ref: '#/components/examples/invalid_json' invalid_null: $ref: '#/components/examples/invalid_null' invalid_parameter: $ref: '#/components/examples/invalid_parameter' missing_request_body: $ref: '#/components/examples/missing_request_body' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Invalid field value or omissible constraint violation. '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Missing or invalid access token. '402': content: application/json: examples: payment_required: $ref: '#/components/examples/payment_required' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Payment Required '403': content: application/json: examples: access_denied: $ref: '#/components/examples/access_denied' method_unauthorized: $ref: '#/components/examples/method_unauthorized' missing_access_token: $ref: '#/components/examples/missing_access_token' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '404': description: Batch job not found or does not belong to this client. '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '423': content: application/json: examples: batch_job_locked: $ref: '#/components/examples/batch_job_locked' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Error '429': content: application/json: examples: too_many_requests: $ref: '#/components/examples/too_many_requests' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Too Many Requests components: schemas: BatchJobUpdateRequest: description: Body of a `PUT /v6/batches/{batchId}` request. properties: name: description: >- Updated human-readable label for the batch job. Omit to leave unchanged. type: string scopes: description: >- Updated access-control scopes. Accepted values: `CLIENT_SUPERUSER`, `CLIENT_ADMIN`. Omit to leave unchanged. items: description: >- Updated access-control scopes. Accepted values: `CLIENT_SUPERUSER`, `CLIENT_ADMIN`. Omit to leave unchanged. enum: - CLIENT_ADMIN - CLIENT_SUPERUSER type: string type: array uniqueItems: true tags: description: >- Updated string labels for filtering and grouping. Replaces the existing tag set. Omit to leave unchanged. items: description: >- Updated string labels for filtering and grouping. Replaces the existing tag set. Omit to leave unchanged. type: string type: array uniqueItems: true type: object RestExceptionResponse: description: Represents the API error response properties: code: description: Specific error code for this error type, documented per endpoint type: string http_status_code: description: >- HTTP status code that was returned with this error, useful if client get response code format: int32 type: integer message: description: User readable English description of the error type: string parameters: additionalProperties: description: >- Attributes related to the error, varies be error code, documented per endpoint type: object description: >- Attributes related to the error, varies be error code, documented per endpoint type: object unique_id: description: >- Unique id associated with this error, useful for discussions with Extole type: string required: - code - http_status_code - message - parameters - unique_id type: object examples: batch_job_data_source_empty: summary: batch_job_data_source_empty value: code: batch_job_data_source_empty http_status_code: 400 message: Data source is required parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 batch_job_delete_not_allowed: summary: batch_job_delete_not_allowed value: code: batch_job_delete_not_allowed http_status_code: 400 message: Batch job cannot be deleted while it's in current status parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 batch_job_event_name_invalid: summary: batch_job_event_name_invalid value: code: batch_job_event_name_invalid http_status_code: 400 message: Invalid batch job event_name, name should have a value, max length 255 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 batch_job_invalid_state_transition: summary: batch_job_invalid_state_transition value: code: batch_job_invalid_state_transition http_status_code: 400 message: Current state doesn't allow the specified operation parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 batch_job_name_invalid: summary: batch_job_name_invalid value: code: batch_job_name_invalid http_status_code: 400 message: Invalid batch job name, name should have a value, max length 255 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 batch_job_tag_invalid: summary: batch_job_tag_invalid value: code: batch_job_tag_invalid http_status_code: 400 message: Invalid batch job tag, name should have a value, max length 255 parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 batch_job_unauthorized_scopes: summary: batch_job_unauthorized_scopes value: code: batch_job_unauthorized_scopes http_status_code: 400 message: Attempt to update scopes to unauthorized values parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 binding_error: summary: binding_error value: code: binding_error http_status_code: 400 message: Argument is not of the expected type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_json: summary: invalid_json value: code: invalid_json http_status_code: 400 message: JSON is invalid parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_null: summary: invalid_null value: code: invalid_null http_status_code: 400 message: The attribute may be omitted but not nullified parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 invalid_parameter: summary: invalid_parameter value: code: invalid_parameter http_status_code: 400 message: Parameter is invalid. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_request_body: summary: missing_request_body value: code: missing_request_body http_status_code: 400 message: Missing request body parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 method_unauthorized: summary: method_unauthorized value: code: method_unauthorized http_status_code: 401 message: Unauthorized access to this endpoint parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 payment_required: summary: payment_required value: code: payment_required http_status_code: 402 message: The access_token provided is associated with an unpaid account. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 access_denied: summary: access_denied value: code: access_denied http_status_code: 403 message: >- The access_token provided is not permitted to access the specified resource. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 missing_access_token: summary: missing_access_token value: code: missing_access_token http_status_code: 403 message: No access_token was provided with this request. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 unsupported_media_type: summary: unsupported_media_type value: code: unsupported_media_type http_status_code: 415 message: Request had an unsupported or no media type parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 batch_job_locked: summary: batch_job_locked value: code: batch_job_locked http_status_code: 423 message: Batch job is locked by another process. Please try again later. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 too_many_requests: summary: too_many_requests value: code: too_many_requests http_status_code: 429 message: >- The server is unable to process your request at the moment, please retry later. parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 securitySchemes: HEADER: in: header name: Authorization type: apiKey x-bearer-format: bearer QUERY: in: query name: access_token type: apiKey COOKIE: in: cookie name: extole_token type: apiKey ````