> ## 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 type > Applies a partial update to the supplied report type. Only the fields present in the body are changed; omitted fields are left intact. Returns the persisted report type after update. ## OpenAPI ````yaml /api-reference/management.json put /v6/report-types/{id} 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: /v6/report-types/{id}: put: tags: - Report Types summary: Update a report type description: >- Applies a partial update to the supplied report type. Only the fields present in the body are changed; omitted fields are left intact. Returns the persisted report type after update. operationId: updateReportType parameters: - description: The Extole unique report type identifier. in: path name: id required: true schema: type: string requestBody: content: application/json: example: allowed_scopes: - CLIENT_ADMIN categories: - categorie component_ids: - component_id component_references: - component_id: component_id socket_names: - socket_name data_start: '2025-10-24T09:00:00.000Z' description: description display_name: display_name formats: - CSV parameters: - category: category default_value: default_value description: description display_name: display_name is_required: true name: name order: 1 type: DYNAMIC type_name: AUDIENCE_ID values: - value scopes: - CLIENT_ADMIN tags: - name: name type: GLOBAL type: CONFIGURED visibility: EXTOLE_ONLY schema: $ref: '#/components/schemas/ReportTypeUpdateRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ReportTypeResponse' description: >- Report type definition including display metadata, parameters, formats, scopes, visibility, tags, and component references. '400': content: application/json: examples: report_type_display_name_too_long: $ref: '#/components/examples/report_type_display_name_too_long' report_type_update_invalid: $ref: '#/components/examples/report_type_update_invalid' report_type_visibility_invalid: $ref: '#/components/examples/report_type_visibility_invalid' 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' report_type_display_name_illegal_character: $ref: >- #/components/examples/report_type_display_name_illegal_character schema: $ref: '#/components/schemas/RestExceptionResponse' description: Forbidden '404': content: application/json: examples: report_type_not_found: $ref: '#/components/examples/report_type_not_found' description: >- Report type was not found. The supplied id does not match any report type 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: ReportTypeUpdateRequest: description: >- Body of `PUT /v6/report-types/{id}`. Polymorphic on `type`: SQL, SPARK, CONFIGURED, and DASHBOARD shapes share the metadata fields below and add their own type-specific fields. Only fields present in the body are applied; omitted fields are left intact. discriminator: mapping: CONFIGURED: $ref: '#/components/schemas/ConfiguredReportTypeUpdateRequest' DASHBOARD: $ref: '#/components/schemas/DashboardReportTypeUpdateRequest' SPARK: $ref: '#/components/schemas/SparkReportTypeUpdateRequest' SQL: $ref: '#/components/schemas/SqlReportTypeUpdateRequest' propertyName: type oneOf: - title: CONFIGURED allOf: - $ref: '#/components/schemas/ConfiguredReportTypeUpdateRequest' - title: DASHBOARD allOf: - $ref: '#/components/schemas/DashboardReportTypeUpdateRequest' - title: SPARK allOf: - $ref: '#/components/schemas/SparkReportTypeUpdateRequest' - title: SQL allOf: - $ref: '#/components/schemas/SqlReportTypeUpdateRequest' required: - tags - type ReportTypeResponse: description: >- Report type definition. Polymorphic on `type`: SQL, SPARK, DASHBOARD, and CONFIGURED share the common metadata below (display name, description, scopes, parameters, formats, tags, data sources) and add their own type-specific fields. discriminator: mapping: CONFIGURED: $ref: '#/components/schemas/ConfiguredReportTypeResponse' DASHBOARD: $ref: '#/components/schemas/DashboardReportTypeResponse' SPARK: $ref: '#/components/schemas/SparkReportTypeResponse' SQL: $ref: '#/components/schemas/SqlReportTypeResponse' propertyName: type oneOf: - title: CONFIGURED allOf: - $ref: '#/components/schemas/ConfiguredReportTypeResponse' - title: DASHBOARD allOf: - $ref: '#/components/schemas/DashboardReportTypeResponse' - title: SPARK allOf: - $ref: '#/components/schemas/SparkReportTypeResponse' - title: SQL allOf: - $ref: '#/components/schemas/SqlReportTypeResponse' required: - allowed_scopes - categories - component_ids - component_references - data_sources - data_start - description - display_name - executor_type - formats - name - parameters - preview_columns - scopes - tags - type - visibility 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 ConfiguredReportTypeUpdateRequest: allOf: - $ref: '#/components/schemas/ReportTypeUpdateRequestBase' - properties: allowed_scopes: items: enum: - CLIENT_ADMIN - CLIENT_SUPERUSER - CONSUMER_PUBLIC type: string type: array uniqueItems: true categories: items: type: string type: array data_start: $ref: '#/components/schemas/Instant' description: type: string display_name: type: string formats: items: enum: - CSV - HEADLESS_CSV - HEADLESS_PSV - JSON - JSONL - PSV - XLSX type: string type: array parameters: items: $ref: '#/components/schemas/ReportTypeParameterDetailsRequest' type: array scopes: items: enum: - CLIENT_ADMIN - CLIENT_SUPERUSER - CONSUMER_PUBLIC type: string type: array uniqueItems: true type: enum: - CONFIGURED type: string visibility: enum: - EXTOLE_ONLY - PRIVATE - PUBLIC type: string type: object required: - allowed_scopes - categories - data_start - description - display_name - formats - parameters - scopes - tags - type - visibility type: object title: CONFIGURED DashboardReportTypeUpdateRequest: allOf: - $ref: '#/components/schemas/ReportTypeUpdateRequestBase' - properties: type: enum: - DASHBOARD type: string required: - tags - type type: object title: DASHBOARD SparkReportTypeUpdateRequest: allOf: - $ref: '#/components/schemas/ReportTypeUpdateRequestBase' - properties: type: enum: - SPARK type: string required: - tags - type type: object title: SPARK SqlReportTypeUpdateRequest: allOf: - $ref: '#/components/schemas/ReportTypeUpdateRequestBase' - properties: allowed_scopes: items: enum: - CLIENT_ADMIN - CLIENT_SUPERUSER - CONSUMER_PUBLIC type: string type: array uniqueItems: true categories: items: type: string type: array data_start: $ref: '#/components/schemas/Instant' database: enum: - ANALYTICS - CUSTOMER_PORTAL - INCENTIVES - LABS - OPTOUT type: string description: type: string display_name: type: string formats: items: enum: - CSV - HEADLESS_CSV - HEADLESS_PSV - JSON - JSONL - PSV - XLSX type: string type: array query: type: string scopes: items: enum: - CLIENT_ADMIN - CLIENT_SUPERUSER - CONSUMER_PUBLIC type: string type: array uniqueItems: true type: enum: - SQL type: string visibility: enum: - EXTOLE_ONLY - PRIVATE - PUBLIC type: string type: object required: - allowed_scopes - categories - data_start - database - description - display_name - formats - query - scopes - tags - type - visibility type: object title: SQL ConfiguredReportTypeResponse: allOf: - $ref: '#/components/schemas/ReportTypeResponseBase' - properties: created_date: $ref: '#/components/schemas/ZonedDateTime' type: enum: - CONFIGURED type: string updated_date: $ref: '#/components/schemas/ZonedDateTime' type: object required: - allowed_scopes - categories - component_ids - component_references - created_date - data_sources - data_start - description - display_name - executor_type - formats - name - parameters - preview_columns - scopes - tags - type - updated_date - visibility type: object title: CONFIGURED DashboardReportTypeResponse: allOf: - $ref: '#/components/schemas/ReportTypeResponseBase' - properties: type: enum: - DASHBOARD type: string required: - allowed_scopes - categories - component_ids - component_references - data_sources - data_start - description - display_name - executor_type - formats - name - parameters - preview_columns - scopes - tags - type - visibility type: object title: DASHBOARD SparkReportTypeResponse: allOf: - $ref: '#/components/schemas/ReportTypeResponseBase' - properties: type: enum: - SPARK type: string required: - allowed_scopes - categories - component_ids - component_references - data_sources - data_start - description - display_name - executor_type - formats - name - parameters - preview_columns - scopes - tags - type - visibility type: object title: SPARK SqlReportTypeResponse: allOf: - $ref: '#/components/schemas/ReportTypeResponseBase' - properties: created_date: $ref: '#/components/schemas/ZonedDateTime' database: enum: - ANALYTICS - CUSTOMER_PORTAL - INCENTIVES - LABS - OPTOUT type: string query: type: string type: enum: - SQL type: string updated_date: $ref: '#/components/schemas/ZonedDateTime' type: object required: - allowed_scopes - categories - component_ids - component_references - created_date - data_sources - data_start - database - description - display_name - executor_type - formats - name - parameters - preview_columns - query - scopes - tags - type - updated_date - visibility type: object title: SQL ReportTypeUpdateRequestBase: properties: component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceRequest' type: array tags: items: $ref: '#/components/schemas/ReportTypeTagRequest' type: array uniqueItems: true type: enum: - CONFIGURED - DASHBOARD - SPARK - SQL type: string 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 ReportTypeParameterDetailsRequest: discriminator: mapping: DYNAMIC: $ref: '#/components/schemas/DynamicReportTypeParameterDetailsRequest' STATIC: $ref: '#/components/schemas/StaticReportTypeParameterDetailsRequest' propertyName: type oneOf: - title: DYNAMIC allOf: - $ref: '#/components/schemas/DynamicReportTypeParameterDetailsRequest' - title: STATIC allOf: - $ref: '#/components/schemas/StaticReportTypeParameterDetailsRequest' ReportTypeResponseBase: properties: allowed_scopes: description: Scopes the report type may be configured for. Superset of `scopes`. items: description: >- Scopes the report type may be configured for. Superset of `scopes`. enum: - CLIENT_ADMIN - CLIENT_SUPERUSER - CONSUMER_PUBLIC type: string type: array uniqueItems: true categories: description: >- Categories used to group report types in the dashboard report builder. items: description: >- Categories used to group report types in the dashboard report builder. type: string type: array component_ids: items: type: string type: array component_references: items: $ref: '#/components/schemas/ComponentReferenceResponse' type: array data_sources: description: Underlying data sources the report type reads from. items: description: Underlying data sources the report type reads from. enum: - AUDIT_EMAIL - BATCH - CLIENT - CLIENT_CHANGE - CONSUMER - CONSUMER_PROFILE - DASHBOARD - DATA_INTELLIGENCE - MESSAGE - NOTIFICATION - PROFILE - REWARD - REWARD_COMMAND - WEBHOOK - WEBHOOK_DISPATCH_RESULT type: string type: array data_start: $ref: '#/components/schemas/ZonedDateTime' description: description: Short description shown alongside the report type in the dashboard. type: string display_name: description: Human-readable name shown in the dashboard. type: string executor_type: description: Engine that executes the report (e.g. SQL, Spark). enum: - DASHBOARD - SPARK - SQL type: string formats: description: Output formats the report type can produce (e.g. CSV, JSON). items: description: Output formats the report type can produce (e.g. CSV, JSON). enum: - CSV - HEADLESS_CSV - HEADLESS_PSV - JSON - JSONL - PSV - XLSX type: string type: array name: description: >- Stable internal name. Use `display_name` for UI; `name` for programmatic lookup. type: string parameters: description: Declared parameters (static + dynamic) the report type accepts. items: $ref: '#/components/schemas/ReportTypeParameterDetailsResponse' type: array preview_columns: description: Column metadata for the report type's preview output. items: $ref: '#/components/schemas/ReportTypeColumnResponse' type: array scopes: description: Scopes the report type currently applies to (e.g. CLIENT, CAMPAIGN). items: description: >- Scopes the report type currently applies to (e.g. CLIENT, CAMPAIGN). enum: - CLIENT_ADMIN - CLIENT_SUPERUSER - CONSUMER_PUBLIC type: string type: array uniqueItems: true tags: description: Tags attached to the report type, used for filtering and grouping. items: $ref: '#/components/schemas/ReportTypeTagResponse' type: array uniqueItems: true type: description: Discriminator selecting the report-type shape. enum: - CONFIGURED - DASHBOARD - SPARK - SQL type: string visibility: description: Whether the report type is PUBLIC, PRIVATE, or restricted. enum: - EXTOLE_ONLY - PRIVATE - PUBLIC type: string 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 ComponentReferenceRequest: properties: component_id: type: string socket_names: items: type: string type: array type: object ReportTypeTagRequest: properties: name: type: string type: enum: - GLOBAL - PRIVATE type: string type: object DynamicReportTypeParameterDetailsRequest: allOf: - $ref: '#/components/schemas/ReportTypeParameterDetailsRequestBase' - properties: type: enum: - DYNAMIC type: string type_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 values: items: type: string type: array uniqueItems: true type: object required: - category - default_value - description - display_name - is_required - name - order - type - type_name - values type: object title: DYNAMIC StaticReportTypeParameterDetailsRequest: allOf: - $ref: '#/components/schemas/ReportTypeParameterDetailsRequestBase' - properties: type: enum: - STATIC type: string required: - category - default_value - description - display_name - is_required - name - order - type type: object title: STATIC ComponentReferenceResponse: properties: component_id: type: string socket_names: items: type: string type: array type: object ReportTypeParameterDetailsResponse: description: Declared parameters (static + dynamic) the report type accepts. properties: category: nullable: true type: string default_value: nullable: true type: string description: 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 ReportTypeColumnResponse: description: Column metadata for the report type's preview output. properties: name: type: string note: nullable: true type: string sample_value: nullable: true type: string type: object ReportTypeTagResponse: description: Tags attached to the report type, used for filtering and grouping. properties: name: type: string type: enum: - GLOBAL - PRIVATE type: string type: object ReportTypeParameterDetailsRequestBase: properties: category: type: string default_value: type: string description: type: string display_name: type: string is_required: type: boolean name: type: string order: format: int32 type: integer type: enum: - DYNAMIC - STATIC type: string type: object 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_type_display_name_too_long: summary: report_type_display_name_too_long value: code: report_type_display_name_too_long http_status_code: 400 message: Report type display name is too long parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_type_update_invalid: summary: report_type_update_invalid value: code: report_type_update_invalid http_status_code: 400 message: Report type not allowed to be updated parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_type_visibility_invalid: summary: report_type_visibility_invalid value: code: report_type_visibility_invalid http_status_code: 400 message: Report type visibility can not be changed 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_type_display_name_illegal_character: summary: report_type_display_name_illegal_character value: code: report_type_display_name_illegal_character http_status_code: 403 message: >- Report type display name can only contain alphanumeric, space, dash, parenthesis, slash, colon, comma, period, underscore, dollar and percentage parameters: {} unique_id: 00000000-0000-0000-0000-000000000000 report_type_not_found: summary: report_type_not_found value: code: report_type_not_found http_status_code: 400 message: Report type referenced by the component is 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 ````