> ## 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 report runner > Applies a partial update to the supplied report runner. Only the fields present in the body are changed; omitted fields are left intact. Returns the persisted report runner after the update. Returns `404 report_runner_not_found` if the id does not exist. Locked runners (`report_runner_locked`) must be updated via deployment tooling. ## OpenAPI ````yaml /api-reference/management.json put /v7/report-runners/{reportRunnerId} openapi: 3.0.1 info: description: >- Configuration endpoints for the Extole platform: campaigns, components, audiences, persons, rewards, reporting, integrations setup, and administrative tooling. title: Management API version: '1.0' servers: - description: Production url: https://api.extole.io security: - HEADER: [] - QUERY: [] - COOKIE: [] tags: - name: Audiences - name: Authentication - name: Batch Jobs - name: Blocks - name: Campaigns - name: Components - name: Components Settings - name: Domains - name: Email - name: Erasure - name: Event Streams - name: File Validation Monitors - name: Optout - name: Profiles - name: Promotion Links - name: Report Schedules - name: Report Types - name: Reports - name: Reward Suppliers - name: Security Keys - name: Settings - name: User Notifications - name: User Subscriptions - name: Users - name: Webhooks paths: /v7/report-runners/{reportRunnerId}: put: tags: - Report Schedules summary: Update a report runner description: >- Applies a partial update to the supplied report runner. Only the fields present in the body are changed; omitted fields are left intact. Returns the persisted report runner after the update. Returns `404 report_runner_not_found` if the id does not exist. Locked runners (`report_runner_locked`) must be updated via deployment tooling. operationId: updateReportRunner parameters: - description: The Extole unique report runner identifier. in: path name: reportRunnerId required: true schema: type: string requestBody: content: application/json: example: component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name deliver_empty_reports_to_sftp: true enabled: true execution_policy: AWAIT_DATA expiration_ms: 1 formats: - CSV merging_configuration: deliverable_type: deliverable_type formats: - CSV sort_by: - sort_by unique_by: - unique_by name: name parameters: parameters_key: parameters_key pause_info: description: description paused: true report_name_pattern: report_name_pattern report_type: report_type scopes: - CLIENT_ADMIN sftp_report_name_pattern: sftp_report_name_pattern sftp_server_id: sftp_server_id tags: - tag type: REFRESHING schema: $ref: '#/components/schemas/ReportRunnerUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReportRunnerResponse' description: Updated report runner. '400': content: application/json: examples: report_runner_invalid_formats: $ref: '#/components/examples/report_runner_invalid_formats' report_runner_locked: $ref: '#/components/examples/report_runner_locked' report_runner_name_exists: $ref: '#/components/examples/report_runner_name_exists' schema: $ref: '#/components/schemas/RestExceptionResponse' description: >- Validation failed. The named examples below cover this operation's most common rejections; other 400 causes are auto-derived from the request body - inspect the response `code` field for the specific error. '401': content: application/json: examples: method_unauthorized: $ref: '#/components/examples/method_unauthorized' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unauthorized '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': content: application/json: examples: report_runner_not_found: $ref: '#/components/examples/report_runner_not_found' description: >- Report runner was not found. The supplied id does not match any report runner accessible to the calling client. '415': content: application/json: examples: unsupported_media_type: $ref: '#/components/examples/unsupported_media_type' schema: $ref: '#/components/schemas/RestExceptionResponse' description: Unsupported Media Type '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: ReportRunnerUpdateRequest: description: Body of a `PUT /v7/report-runners/{reportRunnerId}` request. discriminator: mapping: REFRESHING: $ref: '#/components/schemas/RefreshingReportRunnerUpdateRequest' SCHEDULED: $ref: '#/components/schemas/ScheduledReportRunnerUpdateRequest' propertyName: type oneOf: - title: REFRESHING allOf: - $ref: '#/components/schemas/RefreshingReportRunnerUpdateRequest' - title: SCHEDULED allOf: - $ref: '#/components/schemas/ScheduledReportRunnerUpdateRequest' required: - type ReportRunnerResponse: discriminator: mapping: REFRESHING: $ref: '#/components/schemas/RefreshingReportRunnerResponse' SCHEDULED: $ref: '#/components/schemas/ScheduledReportRunnerResponse' propertyName: type oneOf: - title: REFRESHING allOf: - $ref: '#/components/schemas/RefreshingReportRunnerResponse' - title: SCHEDULED allOf: - $ref: '#/components/schemas/ScheduledReportRunnerResponse' required: - component_ids - component_references - created_date - deliver_empty_reports_to_sftp - enabled - execution_policy - formats - id - merging_configuration - name - parameters - pause_info - paused - report_name_pattern - report_type - report_type_name - scopes - sftp_report_name_pattern - sftp_server_id - tags - type - updated_date - user_id 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 RefreshingReportRunnerUpdateRequest: allOf: - $ref: '#/components/schemas/ReportRunnerUpdateRequestBase' - properties: deliver_empty_reports_to_sftp: nullable: true type: boolean expiration_ms: format: int64 type: integer merging_configuration: $ref: '#/components/schemas/MergingConfigurationRequest' pause_info: $ref: '#/components/schemas/PauseInfoRequest' sftp_server_id: nullable: true type: string type: enum: - REFRESHING type: string type: object required: - type type: object title: REFRESHING ScheduledReportRunnerUpdateRequest: allOf: - $ref: '#/components/schemas/ReportRunnerUpdateRequestBase' - properties: deliver_empty_reports_to_sftp: nullable: true type: boolean frequency: enum: - DAILY - HOURLY - LOGIN - MONTHLY - QUARTERLY - WEEKLY type: string legacy_sftp_report_name_format: type: boolean merging_configuration: $ref: '#/components/schemas/MergingConfigurationRequest' pause_info: $ref: '#/components/schemas/PauseInfoRequest' schedule_start_date: $ref: '#/components/schemas/ZonedDateTime' sftp_server_id: nullable: true type: string type: enum: - SCHEDULED type: string type: object required: - type type: object title: SCHEDULED RefreshingReportRunnerResponse: allOf: - $ref: '#/components/schemas/ReportRunnerResponseBase' - properties: expiration_ms: format: int64 type: integer id: readOnly: true type: string type: enum: - REFRESHING type: string type: object required: - component_ids - component_references - created_date - deliver_empty_reports_to_sftp - enabled - execution_policy - expiration_ms - formats - id - merging_configuration - name - parameters - pause_info - paused - report_name_pattern - report_type - report_type_name - scopes - sftp_report_name_pattern - sftp_server_id - tags - type - updated_date - user_id type: object title: REFRESHING ScheduledReportRunnerResponse: allOf: - $ref: '#/components/schemas/ReportRunnerResponseBase' - properties: frequency: enum: - DAILY - HOURLY - LOGIN - MONTHLY - QUARTERLY - WEEKLY type: string id: readOnly: true type: string legacy_sftp_report_name_format: type: boolean schedule_start_date: $ref: '#/components/schemas/ZonedDateTime' type: enum: - SCHEDULED type: string type: object required: - component_ids - component_references - created_date - deliver_empty_reports_to_sftp - enabled - execution_policy - formats - frequency - id - legacy_sftp_report_name_format - merging_configuration - name - parameters - pause_info - paused - report_name_pattern - report_type - report_type_name - schedule_start_date - scopes - sftp_report_name_pattern - sftp_server_id - tags - type - updated_date - user_id type: object title: SCHEDULED ReportRunnerUpdateRequestBase: properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array deliver_empty_reports_to_sftp: nullable: true type: boolean enabled: type: boolean execution_policy: enum: - AWAIT_DATA - IMMEDIATE type: string formats: items: enum: - CSV - HEADLESS_CSV - HEADLESS_PSV - JSON - JSONL - PSV - XLSX type: string type: array merging_configuration: $ref: '#/components/schemas/MergingConfigurationRequest' name: type: string parameters: additionalProperties: type: string type: object pause_info: $ref: '#/components/schemas/PauseInfoRequest' report_name_pattern: $ref: >- #/components/schemas/ReportNamePatternInReportRunnerUpdateRequestBase report_type: type: string scopes: items: enum: - CLIENT_ADMIN - CLIENT_SUPERUSER - CONSUMER_PUBLIC type: string type: array uniqueItems: true sftp_report_name_pattern: $ref: >- #/components/schemas/SftpReportNamePatternInReportRunnerUpdateRequestBase sftp_server_id: nullable: true type: string tags: items: type: string type: array uniqueItems: true type: enum: - REFRESHING - SCHEDULED type: string type: object MergingConfigurationRequest: properties: deliverable_type: type: string formats: items: enum: - CSV - HEADLESS_CSV - HEADLESS_PSV - JSON - JSONL - PSV - XLSX type: string type: array uniqueItems: true sort_by: items: type: string type: array unique_by: items: type: string type: array type: object PauseInfoRequest: properties: description: nullable: true type: string paused: type: boolean type: object ZonedDateTime: description: >- [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. example: '2025-10-24T02:00:00-07:00' pattern: >- ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$ type: string ReportRunnerResponseBase: properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array created_date: $ref: '#/components/schemas/ZonedDateTime' deliver_empty_reports_to_sftp: type: boolean enabled: type: boolean execution_policy: enum: - AWAIT_DATA - IMMEDIATE type: string formats: items: enum: - CSV - HEADLESS_CSV - HEADLESS_PSV - JSON - JSONL - PSV - XLSX type: string type: array id: readOnly: true type: string merging_configuration: $ref: '#/components/schemas/MergingConfigurationResponse' name: type: string parameters: additionalProperties: $ref: '#/components/schemas/ReportParameterResponse' type: object pause_info: $ref: '#/components/schemas/PauseInfoResponse' paused: $ref: '#/components/schemas/PauseInfoResponse' report_name_pattern: $ref: '#/components/schemas/ReportNamePatternInReportRunnerResponseBase' report_type: type: string report_type_name: type: string scopes: items: enum: - CLIENT_ADMIN - CLIENT_SUPERUSER - CONSUMER_PUBLIC type: string type: array uniqueItems: true sftp_report_name_pattern: $ref: '#/components/schemas/SftpReportNamePatternInReportRunnerResponseBase' sftp_server_id: nullable: true type: string tags: items: type: string type: array uniqueItems: true type: type: string updated_date: $ref: '#/components/schemas/ZonedDateTime' user_id: type: string type: object ComponentReferenceRequest: properties: component_id: type: string socket_names: items: type: string type: array type: object ReportNamePatternInReportRunnerUpdateRequestBase: description: Choose between static or dynamic report name pattern oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Static report name pattern title: Static Value - description: >- Handlebars expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). example: handlebars@runtime:{{reportNamePattern}} externalDocs: description: ReportRunnerExecutionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). example: >- javascript@runtime:function() { return context.get('reportNamePattern');} externalDocs: description: ReportRunnerExecutionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string SftpReportNamePatternInReportRunnerUpdateRequestBase: description: Choose between static or dynamic sftp report name pattern oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Static sftp report name pattern title: Static Value - description: >- Handlebars expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). example: handlebars@runtime:{{sftpReportNamePattern}} externalDocs: description: ReportRunnerExecutionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). example: >- javascript@runtime:function() { return context.get('sftpReportNamePattern');} externalDocs: description: ReportRunnerExecutionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ComponentReferenceResponse: properties: component_id: type: string socket_names: items: type: string type: array type: object MergingConfigurationResponse: properties: deliverable_type: enum: - ACCUMULATING - INDIVIDUAL - NEW_ENTRIES type: string formats: items: enum: - CSV - HEADLESS_CSV - HEADLESS_PSV - JSON - JSONL - PSV - XLSX type: string type: array uniqueItems: true sort_by: items: type: string type: array unique_by: items: type: string type: array type: object ReportParameterResponse: properties: details: $ref: '#/components/schemas/ReportParameterDetailsResponse' value: type: string type: object PauseInfoResponse: properties: description: type: string updated_date: $ref: '#/components/schemas/Instant' user_id: type: string type: object ReportNamePatternInReportRunnerResponseBase: description: >- The report name pattern as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal report name pattern title: Static Value - description: >- Handlebars expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). example: handlebars@runtime:{{reportNamePattern}} externalDocs: description: ReportRunnerExecutionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). example: >- javascript@runtime:function() { return context.get('reportNamePattern');} externalDocs: description: ReportRunnerExecutionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string SftpReportNamePatternInReportRunnerResponseBase: description: >- The sftp report name pattern as configured: a literal value, or an expression (type:string) when defined dynamically. oneOf: - allOf: - type: string - not: anyOf: - pattern: ^handlebars@runtime:.* type: string - pattern: ^javascript@runtime:.* type: string type: string description: Literal sftp report name pattern title: Static Value - description: >- Handlebars expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). example: handlebars@runtime:{{sftpReportNamePattern}} externalDocs: description: ReportRunnerExecutionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts pattern: ^handlebars@runtime:.* title: Runtime - Handlebars type: string - description: >- Javascript expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). example: >- javascript@runtime:function() { return context.get('sftpReportNamePattern');} externalDocs: description: ReportRunnerExecutionContext url: >- https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts pattern: ^javascript@runtime:.* title: Runtime - Javascript type: string ReportParameterDetailsResponse: properties: category: nullable: true type: string display_name: type: string is_required: type: boolean name: type: string order: format: int32 type: integer type: $ref: '#/components/schemas/ReportParameterTypeResponse' type: object Instant: description: >- [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) UTC date-time with a `Z` suffix. Precision up to milliseconds. example: '2025-10-24T09:00:00.000Z' pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?Z$ type: string ReportParameterTypeResponse: properties: name: enum: - AUDIENCE_ID - AUDIENCE_IDS - AUDIENCE_MEMBERSHIPS_METRIC_MAPPING - AUDIENCE_MEMBERSHIPS_ROW_MAPPINGS - AUDIENCE_MEMBERS_ROW_MAPPINGS - BOOLEAN - CAMPAIGN_ID - CAMPAIGN_IDS - CHANNEL_MAPPING - CLIENT_EVENT_METRIC_MAPPINGS - CLIENT_ID - CLIENT_IDS - DATE - DATE_RANGE - DECIMAL - EMAIL_NAMES - ENUM - ENUM_LIST - EQUALITY - FILTER_MAPPINGS - FLOWS - FLOW_FILTER - GRANULAR_TIME_RANGE - ID - IDS - INPUT_RECORD_METRIC_MAPPING - INPUT_RECORD_ROW_MAPPINGS - INTEGER - LONG - MESSAGE_SUMMARY_METRIC_MAPPINGS - METRIC_MAPPINGS - MODEL_CONFIGURATION_METRIC_MAPPING - NORMALIZED_EMAIL - NOT_ARCHIVED_CAMPAIGN_ID - PERSON_DIMENSION_MAPPINGS - PERSON_MAPPINGS - PROGRAM_LABEL - PROGRAM_LABELS - REGEX - REWARD_EVENT_METRIC_MAPPINGS - REWARD_ROW_MAPPINGS - REWARD_SUPPLIER_DISPLAY_TYPES - REWARD_SUPPLIER_IDS - REWARD_SUPPLIER_TYPES - ROW_MAPPINGS - SORT_ORDER_MAPPINGS - SORT_ORDER_MAPPINGS_ON_STEPS - STEP - STEPS - STEP_COLUMN_LIST - STRING - STRING_LIST - TIERS - TIME - TIME_RANGE - WEBHOOK_DISPATCH_METRIC_MAPPING - WEBHOOK_DISPATCH_ROW_MAPPINGS - WEBHOOK_METRIC_MAPPING - WEBHOOK_ROW_MAPPINGS type: string value_type: enum: - DYNAMIC - STATIC nullable: true type: string values: items: type: string nullable: true type: array uniqueItems: true type: object examples: report_runner_invalid_formats: summary: report_runner_invalid_formats value: code: report_runner_invalid_formats http_status_code: 400 message: Report runner formats not supported parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_runner_locked: summary: report_runner_locked value: code: report_runner_locked http_status_code: 400 message: Report runner is locked and cannot be edited via rest api parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_runner_name_exists: summary: report_runner_name_exists value: code: report_runner_name_exists http_status_code: 400 message: Report runner name already exists 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 report_runner_not_found: summary: report_runner_not_found value: code: report_runner_not_found http_status_code: 404 message: Report Runner not found 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 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 ````