API release notes

  • Release version: Zurich
  • Updated July 31, 2025
  • 9 minutes to read

    • ServiceNow® APIs enable you to build custom applications and experiences. APIs were enhanced and updated in the Zurich release.

    API highlights for the Zurich release

    • 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.

    New in the Zurich release

    Table 1. New scoped classes and additional methods to existing scoped classes in Zurich
    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()
    Table 2. New global classes and additional methods to existing global classes in Zurich
    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()
    Table 3. New client classes and additional methods to existing client classes in Zurich
    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()
    Table 4. New REST APIs and additional endpoints to existing REST APIs in Zurich
    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}
    Table 5. New REST APIs and additional endpoints to existing REST APIs in the ServiceNow Store
    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

    Changed in this release

    Table 6. Changed scoped classes in Zurich
    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.
    Table 7. Changed scoped classes in ServiceNow Store
    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.
    Table 8. Changed global classes in Zurich
    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.
    Table 9. Changed REST APIs in the ServiceNow Store
    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.
    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

    Deprecations

    • 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.

    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.