Combined API release notes for upgrades from Zurich to Brazil

reference brazil Updated Nov 6, 2026 31 min read brazil-zurich-api-release-notes.md
Raw file servicenow.com

Consolidated page of all release notes for API from Zurich to Brazil.

How to use this page

To help you prepare for your upgrade, we have combined the cross-family API release notes onto one page. Read this summary of the new features, changes, and updated information for your product from Zurich to Brazil.

Tip: If there were no updates for a release notes section in a certain family release, we included a short note for your reference. For example, if a product did not have any updates in Tokyo, the row says "No updates for this release."

Important information for upgrading API to Brazil

Before you upgrade to Brazil, review these pre- and post-upgrade tasks and complete the tasks as needed.

Release

Release notes

Zurich

No updates for this release.

Australia

No updates for this release.

Brazil

No updates for this release.

## New features

Between your current release family and Brazil, new features were introduced for API.

Release

Release notes

Zurich

Application

App Version

Release month

API

Endpoints

Omnichannel Callback

2.0.4

2026-02

Omnichannel Callback API

Added new endpoints, /get and /close, for retrieving and closing a given callback record. The third endpoint, /actions, allows you to perform create, update, close, and cancel operations for a callback in an external, third-party system with routing capabilities.

  • PATCH api/sn_omichannel_callback/get
  • POST api/sn_omni_callback/actions
  • POST api/sn_omni_callback/callback/close

Contact Center Integration Core

1.5.0

2026-01

External ID Mapping API

  • GET /sn_ct_ctr_it_core/external_id_mapping/table/{tableName}/documentId/{documentId}
  • PUT /sn_ct_ctr_it_core/external_id_mapping/table/{tableName}/documentId/{documentId}

Digital Product Release

2.3.0

2025-12

Digital Product Release API

  • GET /sn_dpr/digital_product_release/bundle/{sysId}
  • GET /sn_dpr/digital_product_release/releases/{releaseId}/policies/status
  • POST /sn_dpr/digital_product_release/product_enhancement
  • POST /sn_dpr/digital_product_release/release
  • POST /sn_dpr/digital_product_release/release/{releaseId}/key_date
  • POST /sn_dpr/digital_product_release/release/{releaseId}/policies/run
  • POST /sn_dpr/digital_product_release/release/{releaseId}/related_task
  • POST /sn_dpr/digital_product_release/release_calendar
  • POST /sn_dpr/digital_product_release/release_id/{releaseId}/complete_phase
  • POST /sn_dpr/digital_product_release/release_target
  • PUT /sn_dpr/digital_product_release/release/{sysId}/retarget

Threat Intelligence Security Center for Security Operations

3.14.4

2025-12

TISC TAXII Server API

  • GET /sn_sec_tisc/taxii_server/taxii2
  • GET /sn_sec_tisc/taxii_server/{api_root}
  • GET /sn_sec_tisc/taxii_server/{api_root}/collections
  • GET /sn_sec_tisc/taxii_server/{api_root}/collections/{id}
  • GET /sn_sec_tisc/taxii_server/{api_root}/collections/{id}/manifest
  • GET /sn_sec_tisc/taxii_server/{api_root}/collections/{id}/objects
  • GET /sn_sec_tisc/taxii_server/{api_root}/collections/{id}/objects/{object_id}
  • GET /sn_sec_tisc/taxii_server/{api_root}/collections/{id}/objects/{object_id}/versions

Telecommunication Open APIs

6.0.9

2025-12

Party Management Open API

New API for managing parties with a relationship to the enterprise. Supports the following methods:

  • DELETE /api/sn_tmf_api/v1/party/individual/{id}
  • GET /api/sn_tmf_api/v1/party/individual/{id}
  • GET /api/sn_tmf_api/v1/party/individual
  • GET/api/ sn_tmf_api/v1/party/organization/{id}
  • GET /api/sn_tmf_api/v1/party/organization
  • PATCH/api/sn_tmf_api/v1/party/individual/{id}
  • PATCH /api/sn_tmf_api/v1/party/organization/{id}
  • POST /api/sn_tmf_api/v1/party/individual
  • POST /api/sn_tmf_api/v1/party/organization

Telecommunication Open APIs

6.0.9

2025-12

Product Inventory Open API

  • DELETE /sn_prd_invt/order/product/{id}
  • PATCH /sn_prd_invt/order/product/{id}

Telecommunication Open APIs

6.0.9

2025-12

Service Catalog Open API

Supports new methods for service offerings and service candidate entity:- DELETE /api/sn_tmf_api/catalogmanagement/serviceCategory/{id}

  • GET /api/sn_tmf_api/catalogmanagement/serviceCategory
  • GET /api/sn_tmf_api/catalogmanagement/serviceCategory/{id}
  • PATCH /api/sn_tmf_api/catalogmanagement/serviceCategory/{id}
  • POST /api/sn_tmf_api/catalogmanagement/serviceCategory

Threat Intelligence Security Center for Security Operations

3.14.4

2025-12

TISC Intel Exchange API

POST /sn_sec_tisc/tisc_intel_sharing_api/post_intel

Threat Intelligence Security Center for Security Operations

3.14.4

2025-12

TISC RPZ API

POST /sn_sec_tisc/rpz_export

Network Inventory Advanced

10.0

2025-08

DCIM Metric Data Feed API

POST /api/sn_ni_adv/dcim/feed/{vendorname}

Omnichannel Callback

2.0.2

2025-08

Omnichannel Callback API

  • POST /api/sn_omni_callback/callback/attempt
  • POST /api/sn_omni_callback/callback/create
  • PATCH /api/sn_omni_callback/callback/update

Quote Management

6.0.1

2025-08

Quote Management API

  • DELETE /sn_tmf_api/quote_management_api/quote/{id}
  • GET /sn_tmf_api/quote_management_api/quote
  • GET /sn_tmf_api/quote_management_api/quote/{id}
  • PATCH /sn_tmf_api/quote_management_api/quote/{id}
  • POST /sn_tmf_api/quote_management_api/quote

Telecommunication Open APIs

4.1.1

2025-08

Work Order Management API

  • CANCEL /sn_tmf_api/work_order_management_api/cancelWorkOrder
  • GET /sn_tmf_api/work_order_management_api/workordermanagement
  • GET /sn_tmf_api/work_order_management_api/workorder/{id}
  • PATCH /sn_tmf_api/work_order_management_api/workOrder/{id}
  • POST /sn_tmf_api/work_order_management_api/workOrder

Class

Methods

GlideCurrencyCode - Scoped, Global

  • getCurrencyCode()
  • getNumericCurrencyCode()

GlideCurrencySymbol - Scoped, Global

  • getCurrencySymbol()
  • getSortedActiveCurrencySymbols()

GlideQueryCondition - Scoped

  • addSystemCondition
  • addSystemOrCondition
  • addUserCondition
  • addUserOrCondition

GlideRecord - Scoped

  • addSystemEncodedQuery()
  • addSystemQuery()
  • addSystemOrderBy()
  • addSystemOrderByDesc()
  • addUserEncodedQuery()
  • addUserQuery()
  • addUserOrderBy()
  • addUserOrderByDesc()

GlideSysAttachment - Scoped

  • addAttribute()
  • addMultipleAttributes()
  • deleteAllAttributes()
  • deleteAttribute()
  • fetchAllAttributes()
  • fetchAttribute()
  • updateAllAttributes()
  • updateAttribute()

GlideSystem - Scoped

Added support for additional message types to display at the top of forms:- addHighMessage()

  • addLowMessage()
  • addSuccessMessage()
  • addModerateMessage()

Class

Methods

GlideDynamicAttribute - Global

Updated content to remove support for dynamic attribute groups.New method getNamespaceName().

GlideDynamicAttributeStore - Global

Updated content to remove support for dynamic attribute groups.New methods:

  • getDynamicNamespace()
  • setDynamicNamespace()

GlideDynamicNamespace - Global

  • getName()
  • isActive()
  • isTransient()

GlideQueryCondition - Global

  • addSystemCondition
  • addSystemOrCondition
  • addUserCondition
  • addUserOrCondition

GlideRecord - Global

  • addSystemEncodedQuery()
  • addSystemQuery()
  • addSystemOrderBy()
  • addSystemOrderByDesc()
  • addUserEncodedQuery()
  • addUserQuery()
  • addUserOrderBy()
  • addUserOrderByDesc()

GlideSysAttachment - Global

  • addAttribute()
  • addMultipleAttributes()
  • deleteAllAttributes()
  • deleteAttribute()
  • fetchAllAttributes()
  • fetchAttribute()
  • updateAllAttributes()
  • updateAttribute()

GlideSystem - Global

Added support for additional message types to display at the top of forms:- addHighMessage()

  • addLowMessage()
  • addModerateMessage()
  • addSuccessMessage()

Message - Global

Retrieves localized messages from the Message [sys_ui_message] table. It supports internationalization (i18n) by dynamically fetching messages based on the user's session language or a specified language parameter.- getMessage()

  • getMessageLang()

Class

Methods

GlideForm (g_form) - Client

  • addChoice()
  • addHighMessage()
  • addLowMessage()
  • addModerateMessage()
  • addSuccessMessage()
  • clearChoices()
  • disableChoice()
  • enableChoice()
  • getAnnotationByName()
  • getAnnotations()
  • getChoice()
  • getOptions()
  • hideAnnotation()
  • hideRelatedLinks()
  • hideTemplateBar()
  • removeChoice()
  • setChoiceLabel()
  • setRelatedLinksDisplay()
  • showAnnotation()
  • showRelatedLinks()
  • showTemplateBar()
  • toggleAnnotations()

GlideModal (Next Experience) - Client

  • destroy()
  • get()
  • getID()
  • getPreference()
  • getPreferences()
  • renderWithContent(Object)
  • renderWithContent(String)
  • setDialog()
  • setPreference()
  • setTitle()
  • type()

GlideNavigation (Next Experience) - Client

refreshNavigator()

StopWatch (Next Experience) - Client

  • StopWatch()
  • getTime()
  • restart()
  • toString()

GlideForm (Next Experience) - Client

  • addChoice()
  • addHighMessage()
  • addLowMessage()
  • addModerateMessage()
  • addSuccessMessage()
  • clearChoices()
  • disableChoice()
  • enableChoice()
  • getAnnotationByName()
  • getAnnotations()
  • getChoice()
  • getOptions()
  • hideAnnotation()
  • removeChoice()
  • setChoiceLabel()
  • showAnnotation()
  • toggleAnnotations()

GlideUser (Next Experience) - Client

getRoles()

API

Endpoints

Conversation Member API

  • PUT now/conversation/member/{user_id}/drop
  • PUT now/conversation/member/{user_id}/update

Omnichannel Callback API

  • POST /api/sn_omni_callback/callback/attempt
  • POST /api/sn_omni_callback/callback/create
  • PATCH /api/sn_omni_callback/callback/update

CSM Pricing API

  • POST /api/sn_csm_pricing/pricingengine/computePrice
  • DELETE /api/sn_csm_pricing/pricingengine/pricing_context/{pricing_context_id}

Australia

Application

App Version

Release month

API

Endpoints

Product Catalog Management

v19.2.0

2026-08

Product Catalog Search API

POST /eligible-catalog-category-hierarchy is a new endpoint that retrieves the complete product catalog-category hierarchy for a given context (customer, currency, pricing rules, etc.). The endpoint automatically applies eligibility rules to filter out ineligible catalogs and categories, ensuring that only offerings qualified for the requesting customer are returned.Note: This REST API wraps the CatalogSearchAPI – getEligibleCatalogCategoryHierarchy(Object input) JavaScript API.

Smart Assessment Engine

 

2026-08

Reassign Assessment API

The new Reassign Assessment API provides a streamlined way to transfer assessment ownership within Smart Assessment workflows. This endpoint enables dynamic reassignment of in-progress assessments when team members change roles, leave the organization, or when assessments need to be delegated to more appropriate team members.

AI Control Tower

v6.0.0

2026-07

AI Assets Inventory API

  • GET /asset-class
  • GET /details

Healthcare and Life Sciences Service Management Core

v1.0

2026-07

HL7 Inbound API

POST /message

Product Catalog Management

v20.0

2026-07

Product Catalog Search API

POST /api/sn_prd_pm/catalog/searchNote: This REST API wraps the CatalogSearchAPI – getEligibleCatalogCategoryHierarchy(Object input) JavaScript API.

Usage Insight Data Export

1.0.1

2026-07

UXA Data Export Service API

POST /sn_uxa_data_export/data_export

Workplace Service Delivery

3.3.1

2026-05

WSD Presence API

  • DELETE /{collaborator_id}
  • DELETE /exception
  • GET /collaborator
  • GET /exception
  • GET /presence
  • GET /routine
  • PATCH /routine
  • POST /collaborator
  • POST /exception
  • POST /routine
  • PUT /exception

Workplace Service Delivery

3.3.1

2026-05

WSD User API

GET /context

Workplace Service Delivery

3.3.1

2026-05

WSD Unified Search API

  • POST /users_and_locations
  • GET /current_location

Synthetic monitoring

1.5.1

2026-03

SyntheticsAsyncBulkCreate API

  • GET /synthetics_async_bulk_create/{job_id}
  • POST /synthetics_async_bulk_create

Class

Methods

CopyDynamicSchemaAPI - Scoped, Global

Methods:

  • getCopyApi()
  • skipAttributes()
  • skipChoiceOverrides()
  • skipChoiceSets()
  • getTransactionId()
  • runAsync()

Extension points:

  • getCopyName()
  • shouldCopy()
  • verifyCopyOperation()

GlideAggregate - Scoped

setAggregateWorkflow()

GlideDate - Scoped

  • getDisplayValueEx()
  • setDisplayValueEx()

GlideTime - Scoped

  • getDisplayValueEx()
  • getDisplayValueLang()
  • setDisplayValueEx()
  • setDisplayValueLang()

GlideElementDescriptor - Scoped, Global

GlideElementDescriptor - isEncrypted()

KafkaProducerAPI - Scoped

  • KafkaProducerAPI()
  • send()

Application

App Version

Release month

Class

Methods

Product Catalog Management

v19.2.0

2026-08

CatalogSearchAPI - Scoped, Global

The new getEligibleCatalogCategoryHierarchy() method lets you retrieve the complete product catalog-category hierarchy for a given context (customer, currency, pricing rules, etc.). The API automatically applies eligibility rules to filter out ineligible catalogs and categories, ensuring that customers see only the offerings they qualify for.Note: The REST version of this endpoint is Product Catalog Search - POST /api/sn_prd_pm/v1/catalog/eligible-catalog-category-hierarchy.

Product Catalog Management

v20.0

2026-07

CatalogSearchAPI - Scoped, Global

  • CatalogSearch() constructor
  • getCatalogData()

Though identically named to CatalogSearch Server API, the new CatalogSearchAPI is a higher-level wrapper specifically for the product catalog use case, with additional capabilities relevant to TMF-aligned product and service offerings.

Note: The Product Catalog Search API REST API wraps this Server API.

Lead to Cash Core

v0.1

2026-05

ConsolidationService - Scoped, Global

  • canConsolidateEntity()
  • canConsolidateJSONs()
  • canMergeEntity()
  • consolidate()
  • enableConsolidation()
  • getHashConfig()
  • getPrimary()
  • overrideAttributeValues()
  • postHierarchyConsolidation()
  • preProcess()

MCP Client

v1.0.1

2026-05

MCPClient - Scoped

  • MCPClient()
  • getServers()
  • getToolInfo()
  • invokeTool()
  • listTools()

Class

Methods

CopyDynamicSchemaAPI - Scoped, Global

Methods:

  • getCopyApi()
  • skipAttributes()
  • skipChoiceOverrides()
  • skipChoiceSets()
  • getTransactionId()
  • runAsync()

Extension points:

  • getCopyName()
  • shouldCopy()
  • verifyCopyOperation()

GlideAggregate - Global

setAggregateWorkflow()

GlideDate - Global

  • getDisplayValueEx()
  • setDisplayValueEx()

GlideElement - Global

getDynamicNamespace()

GlideElementDynamicAttributeStore - Global

  • getDynamicAttributePathsInSchema()
  • getDynamicAttributePathsInStore()
  • getDynamicNamespaceName()

MIDHermesProducer - Global

  • MIDHermesProducer()
  • send()

GlideElementDescriptor - Scoped, Global

GlideElementDescriptor - isEncrypted()

Application

App Version

Release month

Class

Methods

Automated Test Framework

v3.1

2026-08

Cloud Runner TestRunnerApi – Scoped, Global

Three new methods enable asynchronous test job management without requiring sn_boq record creation:- cancelJobByTracker

  • progressFromTracker
  • startJob

Use these methods when you start a test run with startJobAsync and only have the rootTrackerId; no need to poll for a sn_boq record.

Product Catalog Management

v20.0

2026-07

CatalogSearchAPI - Scoped, Global

  • CatalogSearch() constructor
  • getCatalogData()

Though identically named, to CatalogSearch, the new CatalogSearchAPI is used within the product catalog use case, with additional capabilities relevant to TMF-aligned product and service offerings.

Note: The Product Catalog Search API REST API wraps this Server API.

Lead to Cash Core

v0.1

2026-05

ConsolidationService - Scoped, Global

  • canConsolidateEntity()
  • canConsolidateJSONs()
  • canMergeEntity()
  • consolidate()
  • enableConsolidation()
  • getHashConfig()
  • getPrimary()
  • overrideAttributeValues()
  • postHierarchyConsolidation()
  • preProcess()

API

Endpoints

Attachment API

  • DELETE /now/attachment/{attachment_sys_id}/attributes
  • DELETE /now/attachment/{attachment_sys_id}/attributes/{attribute_key}
  • GET /now/attachment/{attachment_sys_id}/attributes/{attribute_key}
  • GET /now/attachments/{attachment_sys_id}/attributes
  • PATCH /now/attachment/{sys_id}
  • POST /now/attachment/{attachment_sys_id}/attributes
  • PUT /now/attachment/{attachment_sys_id}/attributes/{attribute_key}

Help Request API

POST /now/helprequest/action/create_or_update

ATF Code Coverage API

  • POST /now/atf/code_coverage/all
  • POST /now/atf/code_coverage/by_line_number
  • POST /now/atf/code_coverage/by_script_id

Sales CRM Pricing API

  • POST /api/sn_csm_pricing/{api_version}/pricingengine/computePrice
  • DELETE /api/sn_csm_pricing/pricingengine/pricing_context/{pricing_context_id}

Custom Connector Gateway API

  • POST /xcc-ingest (ADDDOCUMENT)
  • POST /xcc-ingest (ADDPRINCIPAL)
  • POST /xcc-ingest (DELETEALLDOCUMENTS)
  • POST /xcc-ingest (DELETEALLPRINCIPALS)
  • POST /xcc-ingest (DELETEBYQUERY)
  • POST /xcc-ingest (DELETEDOCUMENT)
  • POST /xcc-ingest (DELETEPRINCIPAL)
|API|Operations| |---|----------| |[Warranty Claims SOAP API](https://www.servicenow.com/docs/access?context=warranty-claims-SOAP-API&family=australia&ft:locale=en-US)|ProcessRepairOrder: A STAR SOAP operation used to process and exchange repair operation–level information between systems in a standardized STAR XML format.|

Brazil

Application

App Version

API type

API

Endpoints

Telecommunications Open APIs, Order Management for Telecommunications, Media, and Technology

8.0.1, 15.0.0

REST

Product Offering Qualification API

  • POST /queryProductOfferingQualification
  • POST /checkProductOfferingQualification
## Changes

Between your current release family and Brazil, some changes were made to existing API features.

Release

Release notes

Zurich

Application

App Version

Release month

API

Endpoints

Lead to Cash Core

1.7.1

2026-02

LeadtoCashCore - Scoped

createInstance() now supports the allowedContextTypes parameter, enabling partial synchronization of updates or deletions for selected Related Parties back to the originating Opportunity. Previously, partial synchronization behavior was limited to quote line items only.

Lead to Cash Core

1.6

2025-12

LeadtoCashCore - Scoped

To allow more complex business needs, getPrimitivesEPService() supports the new context.entityConfigId parameter, which invokes createInstance() script without any defined mapping using only the entity's configuration ID.

Application

App Version

Release month

API

Endpoints

Telecommunication Open APIs

3.1.0

2026-02

Product Order Open API

When submitting a change payload with a new or updated service location (via productOrderItem.product.place.id), the request is now processed as a move order. This means that the product order remains the same but the service is fulfilled in the new designated location.- Product Order Open API - PATCH /sn_ind_tmt_orm/order/productOrder/{id}

Omnichannel Callback

2.0.4

2025-12

Omnichannel Callback API

Added voicemail information to the callbackContext request parameter in the following endpoints:

  • POST api/sn_omni_callback/callback/create
  • POST api/sn_omni_callback/callback/update

Proactive Service Experience Workflows

7.7.1

2025-12

Trouble Ticket Open API

Now supports creating, retrieving, and filtering on the Service Problem Case ticket type.- GET /sn_ind_tsm_sdwan/ticket/troubleTicket 

  • GET /sn_ind_tsm_sdwan/ticket/troubleTicket/{id}
  • PATCH /sn_ind_tsm_sdwan/ticket/troubleTicket/{id}
  • POST /sn_ind_tsm_sdwan/ticket/troubleTicket

Telecommunication Open APIs

6.0.9

2025-12

Product Catalog Open API

Various methods are enhanced with the following parameters:- externalSystem: Specifies the external system of the product offering catalog.

  • internalVersion: Specifies the version of the product offering.
  • prodSpecCharValueUse.​valueType: Supports more complex product characteristic value types, like choice, check box, objects, and so on.
  • version: Specifies the external version of the product offering.

Enhanced the version and supports external system logic and complex characteristics.

Telecommunication Open APIs

6.0.9

2025-12

Service Catalog Open API

Various methods are enhanced with the following parameters:- externalSystem: Specifies the external system of the service specification.

  • internalVersion: Specifies the version of the service specification.
  • specCharacteristic.valueType: Supports more complex service characteristic value types, like choice, check box, objects, and so on.
  • version: Specifies the external version of the service specification.

Telecommunication Open APIs

6.0.9

2025-12

Product Order Open API

Various methods are enhanced with the following parameters:- externalSystem: Specifies the external system of the product order.

  • internalVersion: Specifies the version of the product specification.
  • productOrderItem.product.productCharacteristic.valueType: Supports more complex product characteristic value types, like choice, check box, objects, and so on.
  • productOrderItem.product.productSpecification.version: Specifies the external version of the product specification.

Telecommunication Open APIs

6.0.9

2025-12

Service Order Open API

Various methods are enhanced with the following parameters:- externalSystem: Specifies the external system of the service order.

  • serviceOrderItem.service.serviceCharacteristic.valueType: Supports more complex service characteristic value types, like choice, check box, objects, and so on.
  • serviceOrderItem.service.serviceSpecification.internalVersion: Specifies the version of the service specification.
  • serviceOrderItem.service.serviceSpecification.version: Specifies the external version of the service specification.

Threat Intelligence Security Center for Security Operations

3.14.4

2025-12

TISC API

POST /sn_sec_tisc/threat_intel_data/observables now supports filtering observables on tags and taxonomies.

Accounts Payable Invoice Processing

v9.5.17

2025-08

AP Invoice API

The following endpoints now support attachments:- POST sn_spend_intg/ap_invoice/json

  • POST sn_spend_intg/ap_invoice/xml

Telecommunication Open APIs

4.1.1

2025-08

Service Order Open API

The following endpoints now support complex service characteristic value types via the serviceOrderItem.service.serviceCharacteristic.valueType parameter:- GET /sn_tmf_api/order/serviceOrder

  • GET /sn_tmf_api/order/serviceOrder/{id}
  • PATCH /sn_tmf_api/order/serviceOrder/{id}
  • POST /sn_tmf_api/order/serviceOrder

Telecommunication Open APIs

4.1.1

2025-08

Product Catalog Open API

The following productSpecification endpoints are updated to support complex product specification characteristic value types via the productSpecCharacteristic.valueType parameter:- POST /sn_tmf_api/catalogmanagement/productSpecification

  • PATCH /sn_tmf_api/catalogmanagement/productSpecification/{id}
  • GET /sn_tmf_api/catalogmanagement/productSpecification/{id}
  • GET /sn_tmf_api/catalogmanagement/productSpecification

Telecommunication Open APIs

4.1.1

2025-08

Product Inventory Open API

The following endpoints now support complex product characteristic value types via the productCharacteristic.valueType parameter:- GET /sn_prd_invt/product

  • GET /sn_prd_invt/product/{id}
  • GET /sn_prd_invt/productinventory
  • GET /sn_prd_invt/productinventory/{inventoryId}
  • POST /sn_prd_invt/product
  • POST /sn_prd_invt/productinventory

Telecommunication Open APIs

4.1.1

2025-08

Product Order Open API

The following endpoints now support complex product characteristic value types via the productOrderItem.product.productCharacteristic.valueType parameter:- GET /sn_ind_tmt_orm/order/productOrder

  • GET /sn_ind_tmt_orm/order/productOrder/{id}
  • GET /sn_ind_tmt_orm/productorder
  • GET /sn_ind_tmt_orm/productorder/{id}
  • PATCH /sn_ind_tmt_orm/order/productOrder/{id}
  • PATCH /sn_ind_tmt_orm/productOrder/{id}
  • POST /sn_ind_tmt_orm/order/productOrder
  • POST /sn_ind_tmt_orm/productOrder

Virtual Agent API

4.0.0

2025-08

Virtual Agent Bot Integration API

New options for the action request body parameter with corresponding examples.POST /sn_va_as_service/bot/integration

Class

Methods

GlideSysAttachment - Scoped

Support for copying any attributes from source attachment records and deleting attributes with attachments.- copy()

  • copy(targetFieldName)
  • copyAttachmentsByFieldNames()
  • deleteAllAttachment()
  • deleteAttachment()

IdentificationEngine - Scoped

Enable the referenceItems properties of the incoming payload to be populated before identifying a CI using the IRE rules defined on a class.- createOrUpdateCI()

  • createOrUpdateCIEnhanced()
  • identifyCIEnhanced()

ProducerV2 - Scoped

send() - Added a return value and error handling.

RESTMessageV2 - Scoped, Global

setHttpMethod() - Added support for HEAD method calls via the method parameter.

Class

Methods

GlideAggregate - Global

Remove support for groups in Dynamic Schema.- addAggregate()

  • addHaving()
  • getDynamicAttributeValue()
  • getDynamicAttributeDisplayValue()
  • getValue()
  • groupBy()
  • orderBy()
  • orderByAggregate()

GlideDynamicAttribute - Global

Remove support for groups in Dynamic Schema. - getGroupName()

  • getName()
  • getPath()
  • getType()
  • isTransient()

Remove getSysId().

Remove GlideTransientDynamicAttribute API documentation because GlideDynamicAttribute and GlideTransientDynamicAttribute APIs provide the same solution.

GlideRecord - Global

Remove support for groups in Dynamic Schema.- addQuery()

  • getDisplayValue()
  • getDynamicAttribute()
  • getDynamicAttributeDisplayValue()
  • getDynamicAttributeValue()
  • getValue()orderBy()
  • orderByDesc()
  • setDisplayValue()
  • setDynamicAttributeDisplayValue()
  • setDynamicAttributeValue()
  • setDynamicAttributeValues()
  • setValue()

GlideSysAttachment - Global

Support for copying any attributes from source attachment records and deleting attributes with attachments.- copy()

  • copy(targetFieldName)
  • copyAttachmentsByFieldNames()
  • deleteAllAttachment()
  • deleteAttachment()

IdentificationEngineScriptableApi - Global

Enable the referenceItems properties of the incoming payload to be populated before identifying a CI using the IRE rules defined on a class.- createOrUpdateCI()

  • createOrUpdateCIEnhanced()
  • identifyCIEnhanced()

RESTMessageV2 - Scoped, Global

setHttpMethod() - Added support for HEAD method calls via the method parameter.

Australia

Application

App Version

Release month

Module

Types

Mobile SDK Libraries - Android

2.24.0

2026-08

  • NowChat
  • NowWeb

Default colors for NowChatTheme interface - Android and NowWebTheme interface - Android now use the Coral theme.

Mobile SDK Libraries - iOS

2.24.0

2026-08

NowUIColoring

Default colors for NowUIColoring now use the Coral theme.

Mobile SDK Libraries - iOS

2.22.0

2026-06

NowChat

New properties on NowChatConfiguration class - iOS enable NowChat to integrate with NowVoice:- voiceConfiguration

  • voiceUIConfiguration
  • voiceCallbacks
The following tables lists changed API classes and methods in Australia and ServiceNow Store.

Application

App Version

Release month

Class

Methods

Lead to Cash Core

v1.8

2026-03

LeadtoCashCore - Scoped

The following enhancements provide support for building and committing complete, ramp entity structures across header and headerless workflows:- LeadtoCashCore - createInstance(String headerSysIDs, String lineSysIDs, Boolean isTarget, Object additionalParams): This method now supports selective record retrieval and multiple root entity definitions, enabling developers to explicitly fetch and aggregate ramp data in both single‑ and multi‑select, headerless scenarios.

Lead to Cash Core

v1.9

2026-06

LeadtoCashCore - Scoped

LeadtoCashCore - commitInstance(Object targetJSON, Object additionalParams)- Added an optional additionalParams.returnDeletedGr Boolean flag that, when set to true, causes the deleted GlideRecord to be passed to _postProcess and _postHierarchyCommit after a DELETE operation.

Class

Methods

GlideForm (g_form) - Client

On fields set to strict read only, the following methods do nothing and log a warning in the browser's console if used:- clearValue()

  • setValue()

For more information, see Read-only options.

GlideForm (Next Experience) - Client

On fields set to strict read only, the following methods do nothing and log a warning in the browser's console if used:- clearValue()

  • setValue()

For more information, see Read-only options.

openFrameAPI - Client

setICContext() - New searchTargetList.quickStats object provides agent status information.

Application

App Version

Release month

Class

Methods

Customer Service Management (CSM)

v1.2

2026-07

openFrameAPI - Client

setICContext():

  • added activeConversations and agentSettings are added as new context inputs.

subscribe(): Added openframe_awa_workitem_cancelled as a new event.

API

Endpoints

Attachment API

POST /now/attachment/file now returns 403 Forbidden instead of 401 Unauthorized when access is denied at the ACL layer. To authenticate with this API, use OAuth 2.0 or enable preemptive authentication on the REST client. For more information, see KB3054410.

Party Management Open API

Previously, all GET endpoints didn't return results for Account records as expected due to a hardcoded flag. As a fix, users are now required to install the plugin Customer Service Base Entities (com.snc.cs_base), which adds the Active field to Customer [customer_account] and Core Company [core_company] tables.- Party Management – GET /api/sn_tmf_api/v1/party/individual

Wrap Up API

Added support for AI-generated wrap‑up codes and notes.- Wrap Up - GET /now/wrapup/segment/{segment_id}

Application

App Version

Release month

API

Endpoints

Telecommunications Open APIs (sn_tmf_api)

v7.2.0

2026-08

Updated APIs:

These TMF APIs are updated with the following:

  1. You can now safely customize TMF API behavior for your business needs, without modifying ServiceNow®'s default code or risking conflicts when you upgrade. Custom extensions automatically inherit all version-specific logic (such as external ID fields in responses), ensuring your integrations always work correctly. This V2 pattern works the same way across all TMF APIs, so you get a predictable, documented approach whether you're customizing one API or several. Existing V1 APIs and integrations are unaffected.

Note: By default, the product ships with V1 as the default version. Any API calls to the standard URL use V1 logic. If you want to use V2, you have two options:

-   Toggle the "Is default" checkbox in the sys\_ws\_definition record to make V2 the default for all calls.
-   Call the version-specific V2 URL directly from your integration source.
  1. externalId is now returned in V2 GET/LIST responses.

Telecommunications Open APIs (sn_tmf_api)

v7.2.0

2026-08

Party Management Open API

This release contains two updates to the Party Management Open API:

  1. The Party Management Open API has been updated to align with TMF 632 CTK (Core Transaction Kernel) compliance standards. The PartyOrPartyRole object has been removed and replaced with a mandatory @type field at the root level to explicitly declare party type (Account, Consumer, or Contact). The relatedParty object now includes a mandatory @type field to align with the latest TMF 632 schema. For migration guidance, see the related documentation.
  2. Supports inline creation and association of Contact and Location records during organization creation in a single request, eliminating the need for separate POST operations. The mediumType field has been renamed to contactType (with fax renamed to faxPhone); update any existing integrations accordingly. Organization responses now include createdDate and lastModifiedDate audit timestamps, plus support for organizationChildRelationship and organizationParentRelationship fields for organizational hierarchies.

Virtual Agent (sn_va_as_service)

v4.4.0

2026-08

Virtual Agent Bot Integration API

Now supports synchronous responses for the START_CREATED_CONVERSATION and CREATE_CONVERSATION actions. By setting the syncResponse parameter to true in the request body,

  • CREATE_CONVERSATION: Callers receive the conversation ID and interaction details in the API response, ensuring the conversation is fully initialized before the response is returned.
  • START_CREATED_CONVERSATION: Prevents potential race conditions and timing issues, for example when using the AWA Offer Work API.

Automated Test Framework

v3.1

2026-07

Cloud Runner Test Runner REST API

The following endpoints are updated as follows:

  • POST /test_runner: Now supports asynchronous test execution via the new sync parameter.
  • POST /cancel_test_runner: Introduces rootTrackerId as an alternative identifier for tracking and canceling test runs.
  • GET /test_runner_progress: Introduces rootTrackerId as an alternative identifier for tracking and canceling test runs.

All Cloud Runner Test REST APIs now standardize on HTTP error codes: 400 for validation errors and 500 for unexpected errors.

Synthetic monitoring

1.7.1

2026-07

SyntheticsAsyncBulkCreate API

Updated functionality for POST /synthetics_async_bulk_create: - Checks for uniqueness against existing monitors on the fields name, url, location, valid_http_code, and valid_http_code_type to avoid creating duplicates.

  • Request parameters parent_service_sys_id and support_group_sys_id are no longer required for endpoints that have a parent service relationship in the CI Relationship [cmdb_rel_ci] table.

Telecommunications Service Management

v4.1.1

2026-07

Party Management Open API

The POST /organization endpoint now supports a list of valid partyCharacteristic.name values.As a result, the partyCharacteristic.value attribute accepts the display value of rankTier and industry choice fields as input. Invalid choice values trigger a descriptive warning in the API response, enabling clearer validation feedback and improved data consistency.

Order Management for Telecommunications

v4.0

2026-07

Service Order Open API

For all endpoints, the serviceOrderItem.orderRelationship parameter is renamed to serviceOrderItem.serviceOrderItemRelationship. This change affects both requests and responses.

Order Management for Telecommunications

v12.5.0

2026-06

The characteristicObj parameter is introduced as a fix to validate the .value property against allowed choice-type values by default. If an invalid value is submitted, the API adds a work note to the record.A new system property, sn_ind_tmt_orm.disableCharValueValidation, allows you to revert to pre-fix behavior when needed. The property isn't shipped by default. To turn off validation, create a system property named sn_ind_tmt_orm.disableCharValueValidation and set the value to true. When turned off, the value is set directly from the request payload and no work notes are generated.

Workplace Reservation Management

v1.0

2026-05

WSD Reservation API

In the POST /add endpoint, the reservable_module request parameter is no longer required as of this release, but is required for earlier releases.

Brazil


Application

App Version

API type

API

Methods/Endpoints

Customer Service Management

6.7.5

REST

Trouble Ticket Open API

Important: Migration Notice

Starting with the November 2026 release, the Trouble Ticket API transitions scope to Telecom Service Management Core (sn_ind_tsm_core) from SD-WAN (sn_ind_tsm_sdwan). Existing sn_ind_tsm_sdwan endpoints remain available but are deprecated until the Denmark release.Migrate your integrations to the new endpoints before the Denmark release to avoid disruption. See Trouble Ticket Open API documentation for timeline and migration guidance.

Customer Service Management

6.7.5

Server

TroubleTicketNotificationUtilOOB - Scoped

Starting with the November 2026 release, Trouble Ticket APIs transitions scope from sn_ind_tsm_sdwan to sn_ind_tsm_core. An automatic upgrade is planned for the December release for existing customers whose instances use S-DWAN.

Customer Service Management

1.8.0

REST

[Placeholder link text to key openframe-POST-voice-interaction]

POST /openframe/voice-interaction endpoint now returns an existing callback interaction instead of creating a new one when the first item in the relatedRecords array is an interaction record. This helps avoid duplicate interaction records when an agent calls a customer back from a callback interaction. The response includes the sys_id and number of the existing interaction.

- ****

Application

App Version

API type

API

Methods/Endpoints

Universal MCP Client

1.1.3

Server

MCPClient - Scoped

A new parameter caller_product is added to specify the scope name of the application making the API call. This parameter is required for the following methods.- getServers()

  • getToolInfo()
  • invokeTool()
  • listTools()

Mobile SDK Libraries - Android

2.26.0

Mobile SDK

NowChatConfiguration class - Android

New optional parameters added to UIConfiguration().- hideServiceNowInProductBranding: Show or hide ServiceNow branding in Virtual Agent.

  • voiceInputButton: Show or hide the speech-to-text microphone button in the text input bar.

Mobile SDK Libraries - iOS

2.26.0

Mobile SDK

NowChatConfiguration class - iOS

New optional parameters added to UIConfiguration().- hideBranding: Show or hide ServiceNow branding in Virtual Agent.

  • voiceInputButton: Show or hide the speech-to-text microphone button in the text input bar.

Order Management for Telecommunications and Media

15.0.4

REST

Product Order Open API

The PATCH /sn_ind_tmt_orm/order/productOrder/{id} endpoint now accepts the V3 relatedParty item shape (role/@type/partyOrPartyRole). PATCH supports only the reference pattern for both V2 and V3 versions of the API.

Telecommunications Service Management

8.0.3

REST

Product Inventory Open API

In the GET /product and GET /{id} endpoints, the productCharacteristic.valueType field now supports a new sn_prd_invt.enableseamlessvaluetype system property that, when enabled, returns the same backend value format the Product Order API already uses, allowing consistent characteristic value types across both APIs.

Omnichannel Callback for Customer Service Management (sn_callback)

1.8.3

REST

Voice Interaction Resource API

The POST /api/now/openframe/voice-interaction endpoint now prevents duplicate interactions by reusing existing work-in-progress callbacks when an agent clicks to call from the workspace. The system checks for WIP interactions with matching inbound_id and parties before creating a new record, and accepts a new relatedRecords objecy to pass callback context via context_document and context_table fields.

- ****

Application

App Version

API type

API

Methods/Endpoints

Workplace Calendar Synchronization

3.4.16

REST

WSD Recurring Reservation API

POST /create_series: The recurringPattern parameter now uses RFC 5545 iCalendar format (freq, dtstart, interval, byweekday, tzid, etc.) for better timezone handling and standards compliance. Note: Legacy format patterns (using repeats, options.*, and startDate) remain supported and continue to work without changes.

Interaction Controls Component

3.0.1

Client

openFrameAPI - Client

  • setICContext(): Supports supervisor monitoring controls (coaching, monitoring, barging), callback transfer enhancements with directTarget support, and clarified conditional logic for callback context timing.
  • subscribe(): Supports five new callback-related sub-actions (callbackLeaveAndTransfer, getSearchTarget, getMoreInfo, callbackTransferInitiated, cancelCallbackTransfer) and the openframe_icc_record_opened event for manager role interaction tracking.

Product Catalog Management Core application

20.0.2

REST

Product Catalog Search API

The POST /search endpoint now returns the productOfferingFamily field, which identifies the product offering family that each offering belongs to.

Product Catalog Management Core application

20.0.2

Server

CatalogSearchAPI - Scoped, Global

The getCatalogData() now returns the productOfferingFamily field, which identifies the product offering family that each offering belongs to.

Telecommunications Open APIs, Order Management for Telecommunications, Media, and Technology

8.0.1, 15.0.0

REST

Product Order Open API

PATCH /productOrder/{id}: - Now supports a changeType=nonProduct parameter to update order and line item administrative details without triggering product change workflows or state transitions.

  • Now accepts either the system ID (sys_id) or external ID (external_id) in the productOrderItem.id field, reducing the need for additional lookups when updating line items.
  • Supports associating payment profiles, billing accounts, and related parties (Account, Contact, Location, and Consumer) with product orders. This allows clients to link existing records or create new ones inline during order placement for streamlined end-to-end order workflows. GET/LIST endpoints now support the following query parameters: Account, Contact and Consumer(Related Party), externalID.

Telecommunications Open APIs, Order Management for Telecommunications, Media, and Technology

8.0.1, 15.0.0

REST

Service Order Open API

GET/LIST endpoints now support the following query parameters: Account, Contact and Consumer(Related Party), externalID, expectedStartDate, CompletionDate, requestedStartDate, requestedCompletionDate, expectedCompletionDate.

Telecommunications Open APIs, Order Management for Telecommunications, Media, and Technology

8.0.1, 15.0.0

REST

Product Inventory Open API

GET/LIST endpoints now support the following query parameters: Account, Contact and Consumer(Related Party), billingAccount.

Telecommunications Open APIs, Order Management for Telecommunications, Media, and Technology

8.0.1, 15.0.0

REST

Product Catalog Open API

GET/LIST endpoints now support the following query parameters: externalID, isSellable

Telecommunications Open APIs, Order Management for Telecommunications, Media, and Technology

8.0.1, 15.0.0

REST

Service Test Management Open API

All GET and POST endpoints responses return id and externalId as distinct fields on ServiceTest and ServiceTestSpecification resources. The id field returns the record's sys_id, and externalId returns the value of the external_id column when one is set. Existing query resolution behavior is unchanged, so requests that filter on an external identifier continue to work.

Telecommunications Open APIs, Order Management for Telecommunications, Media, and Technology

8.0.1, 15.0.0

REST

Product Catalog Open API

GET/LIST endpoints: Supports the Accept-Language request header on GET and LIST operations for retrieving translated field values, and filtering by translated name on LIST operations.

## Removed

Between your current release family and Brazil, some API features or functionality were removed.

Release

Release notes

Zurich

No updates for this release.

Australia

No updates for this release.

Brazil

No updates for this release.

## Deprecations

Between your current release family and Brazil, some API features or functionality were deprecated.

Release

Release notes

Zurich

  • The GlideEncrypter API no longer supports Triple Data Encryption Standard (3DES) due to updated NIST 800-131A Rev 2 guidelines.
    • For existing instances that upgrade to the Zurich release, the GlideEncrypter API is available for use but has been updated to automatically use the Key Management Framework algorithm. See GlideEncrypter - Global (deprecated) for more information on how to continue calling this API.
    • For all new instances created starting with the Zurich release, the GlideEncrypter API is no longer supported. Directly use the Key Management Framework instead for all cryptography operations.
  • Dynamic groups have been removed from dynamic schema in Core Platform. For dynamic attributes defined with an associated dynamic attribute group before the Zurich release, the GlideDynamicAttribute getGroupName() method originally designed for dynamic attribute groups continues to work for backwards compatibility.

The getGroupName() method returns null for migrated attributes and newly created attributes.

Customers are urged to migrate to the current Dynamic Attribute definitions to take advantage of future improvements in features and functionality. For migration details, see the Dynamic Schema Zurich Migration Guide [KB2146133] article in the Now Support Knowledge Base.

  • For existing instances that upgrade to the Zurich release, the GlideEncrypter API is available for use but has been updated to automatically use the Key Management Framework algorithm. See GlideEncrypter - Global (deprecated) for more information on how to continue calling this API.
  • For all new instances created starting with the Zurich release, the GlideEncrypter API is no longer supported. Directly use the Key Management Framework instead for all cryptography operations.

Australia

  • NowAnalyticsService, NowAnalyticsServiceDelegate, and SNMobileAnalytics have been removed from Mobile SDK - iOS.

  • NowAnalyticsSDK has been removed from Mobile SDK - Android.

  • GlideElementDynamicAttribute has been removed. Use other GlideElement instances corresponding to an attribute's type instead.

Brazil

  • Trouble Ticket Open API

Trouble Ticket Open API endpoints under the sn_ind_tsm_sdwan scope are deprecated but remain available until the Denmark release, at which point they will be officially removed and inaccessible. Endpoints use a new sn_ind_tsm_core scope as of the November 2026 release. See Trouble Ticket documentation for migration guidance and timeline information.

## Activation information

Review information on how to activate API.

Release

Release notes

Zurich

  • Activation information

The following APIs are available by default:

-   Identification and Reconciliation
-   IdentificationEngine
-   IdentificationEngineScriptableApi
-   GlideDynamicAttribute
-   GlideDynamicAttributeStore
-   GlideDynamicNamespace
-   GlideCurrencyCode
-   GlideCurrencySymbol
-   GlideForm \(Next Experience\)
-   GlideModal \(Next Experience\)
-   GlideNavigation \(Next Experience\)
-   GlideQueryCondition
-   GlideRecord
-   GlideSysAttachment
-   GlideUser\(Next Experience\)
-   StopWatch \(Next Experience\)

The following APIs require plugin activation:

-   ProducerV2 requires the ServiceNow Stream Connect Installer plugin \(com.glide.hub.stream\_connect.installer\).
-   Product Order Open API requires the Order Management for Telecommunications \(sn\_ind\_tmt\_orm\) plugin.
-   Service Order Open API requires the Order Management for Telecommunications \(sn\_ind\_tmt\_orm\) plugin.
-   The Omnichannel Callback API requires the Omnichannel Callback \(omnichannel\_callback plugin\) plugin.
-   Party Management Open API requires the Telecommunications Open APIs \(sn\_tmf\_api\) and Customer Service Management \(com.sn\_customerservice\) plugins.
-   The SegmentHandle, SegmentHandler, and sn\_erp\_integration API APIs require the Zero Copy Connector for ERP \(com.sn\_erp\_integration\) plugin.

Australia

  • Activation information

The following APIs are available by default:

-   ATF Code Coverage API
-   Attachment API
-   GlideAggregate
-   GlideDate
-   GlideTime
-   GlideElement
-   GlideElementDescriptor
-   GlideElementDynamicAttributeStore
-   GlideForm
-   GlideForm\(Next Experience\)

The following APIs require plugin activation:

-   CopyDynamicSchemaAPI API requires the Dynamic Schema Support \(com.glide.dynamic\_schema\) plugin.
-   Help Request API requires the Interactions Management \(com.glide.interaction\) plugin.
-   MIDHermesProducer requires the MID Hermes API \(com.glide.mid.hermes\_api\) plugin.
-   Party Management Open API requires the Customer Service Base Entities \(com.snc.cs\_base\) plugin.
-   Wrap Up API requires the requires the Interactions Management \(com.glide.interaction.awa\) plugin.
-   WSD Presence API requires the Workplace Service Delivery Core \(com.sn\_wsd\_core\) plugin.
-   WSD Unified Search API requires the Workplace Service Delivery Core \(com.sn\_wsd\_core\) plugin.
-   WSD User API requires the Workplace Service Delivery Concierge \(com.sn\_wsd\_concierge\), Workplace Service Delivery Core \(com.sn\_wsd\_core\), and Workplace Service Delivery Reservation \(com.sn\_wsd\_rsv\) plugins.

Brazil

  • Activation information

API activation is dependent on the specific product or application where the API is required. Consult your product documentation or contact your ServiceNow® administrator to determine activation steps for your use case.

## Additional requirements

If any additional requirements were introduced or changed for API we have noted them here.

Release

Release notes

Zurich

No updates for this release.

Australia

No updates for this release.

Brazil

No updates for this release.

## Browser requirements

If any specific browser requirements were introduced or changed for API we have noted them here.

Release

Release notes

Zurich

No updates for this release.

Australia

No updates for this release.

Brazil

No updates for this release.

## Accessibility information

Review details on accessibility information for API, such as specific requirements or compliance levels.

Release

Release notes

Zurich

No updates for this release.

Australia

No updates for this release.

Brazil

No updates for this release.

## Localization information

If there are specific localization considerations for API we have noted them here.

Release

Release notes

Zurich

No updates for this release.

Australia

No updates for this release.

Brazil

No updates for this release.

## Highlight information

If there are specific highlight considerations for API we have noted them here.

Release

Release notes

Zurich

  • Use server-side JavaScript APIs in scripts to change the application functionality.
  • Run client APIs whenever a client-based event occurs, such as when a form loads, a form is submitted, or a field value changes.
  • Use inbound REST APIs to interact with various ServiceNow functionalities within your application.
  • Client Next Experience APIs include client APIs compatible with the Next Experience UI.

See API implementation and reference for more information.

Australia

  • Use server-side JavaScript APIs in scripts to change the application functionality.
  • Run client APIs whenever a client-based event occurs, such as when a form loads, a form is submitted, or a field value changes.
  • Use inbound REST APIs to interact with various ServiceNow functionalities within your application.
  • Client Next Experience APIs include client APIs compatible with the Next Experience UI.

See API implementation and reference for more information.

Brazil

  • Use server-side JavaScript APIs in scripts to change the application functionality.
  • Run client APIs whenever a client-based event occurs, such as when a form loads, a form is submitted, or a field value changes.
  • Use inbound REST APIs to interact with various ServiceNow functionalities within your application.
  • Client Next Experience APIs include client APIs compatible with the Next Experience UI.

See API implementation and reference for more information.

**Parent Topic:**[Products combined by family](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/brazil/markdown/delta-zurich-brazil/rn-combined-intro.md)
Search documentation
Search document titles and file paths on the brazil branch