API release notes

topic brazil Updated Sep 10, 2026 9 min read api-rn-static.md
Raw file servicenow.com

The ServiceNow® APIs enable organizations to programmatically integrate ServiceNow® with other systems, automate business processes, and extend platform capabilities to create seamless, end-to-end workflows across their entire IT and business ecosystem. See the following sections for release notes by family and store release.

About ServiceNow® APIs

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

Activation and other requirements

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

Parent Topic:Features and changes by product

November 5, 2026

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

What's changed

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

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.
### What's deprecated or removed

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

October 2026

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

What's new

What's changed

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.
## Brazil Early Availability

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

What's new

Application

API type

API

Methods/Endpoints

Developer Sandboxes

REST

Developer Sandbox Management API

Programmatically create, list, retrieve, and destroy isolated development environments within a ServiceNow® instance.- DELETE /dsbName

  • GET /operationId
  • GET /sandboxes
  • GET /sysId
  • POST /sandboxes

Stream Connect

REST

Schema Registry API

Retrieve Avro schemas along with their subject and version history.- GET /schemas

  • GET /schemas/ids/{id}
  • GET /schemas/ids/{id}/schema
  • GET /schemas/ids/{id}/subjects
  • GET /schemas/ids/{id}/versions
  • GET /subjects
  • GET /subjects/{subject}/versions
  • GET /subjects/{subject}/versions/{version}
  • GET /subjects/{subject}/versions/{version}/schema

Sales Cart

REST

Sales Cart REST API

Programmatically create, read, update, and submit a sales cart and its line items, or remove a cart or line item entirely.- POST /sales_cart

  • PATCH /v1/sales_cart
  • GET /v1/sales_cart
  • GET /sales_cart/{cart_id}
  • GET /sales_cart/{cartId}/line-item/{lineItemId}
  • POST /sales_cart/{cart_id}/submitorder
  • DELETE /sales_cart/{cart_id}
  • DELETE /sales_cart/{cartId}/line-item/{lineItemId}

Platform (Glide)

Mobile Scripting

The Mobile Offline Scripting APIs introduce a set of scripting classes in the sn_mobile_scripting namespace that can run against data stored on a user's device. These classes query and modify records, read and write field values, and evaluate dates and times, so button conditions and write-back actions continue to work while the mobile app is offline. Because mobile scripts are a subset of the scripting capabilities available in the browser, the same script runs on the instance without modification when connectivity is available.

Process Mining

Server

ProcessMiningIntegrationAPI - Scoped

createProjectFromApi(): Create a process mining project and retrieve project data.

Unified Secrets Gateway

Server

SecretsAPI - Scoped

Provides an entry point for delivering credentials to a MID Server without requiring the caller to know the underlying storage mechanism.Available methods:

  • getSecret()
  • getSecrets()

AI Search

REST

Custom Connector Gateway API

Push documents and user principals from a connector in your own environment into AI Search, so you can index sources that ServiceNow can't reach.- 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)
### What's changed
  • Application API type API Endpoints
    Virtual Agent and Live Agent REST Virtual Agent Bot Integration API POST /bot/integration: The history parameter of the Virtual Agent Bot Integration API now supports an attachment type, letting the primary bot include files that were shared earlier in the conversation when it passes chat history to Virtual Agent or Live Agent.

What's deprecated or removed

  • ProcessMiningIntegrationAPI - Scoped

    The createProject() method is deprecated. Use createProjectFromApi() instead. The properties promin.api.allow_no_role_mining and promin.api.auto_share_project_with_creator are also deprecated.

September 2026

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

What's new

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
### What's changed

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.
Search documentation
Search document titles and file paths on the brazil branch