Contexts
Update a context
Update the data of an existing context. type and id are required fields, data is required. Only the data field is updated, the rest of the context is not affected. If the context does not exist, it returns the 404 response
PATCH
/
v2
/
contexts
/
{type}
/
{id}
TypeScript
import { Novu } from "@novu/api";
const novu = new Novu({
secretKey: "YOUR_SECRET_KEY_HERE",
});
async function run() {
const result = await novu.contexts.update({
id: "<id>",
type: "<value>",
updateContextRequestDto: {
data: {
"tenantName": "Acme Corp",
"region": "us-east-1",
"settings": {
"theme": "dark",
},
},
bridgeUrl: "https://tenant-acme.example.com/api/novu",
},
});
console.log(result);
}
run();using Novu;
using Novu.Models.Components;
using System.Collections.Generic;
var sdk = new NovuSDK(secretKey: "YOUR_SECRET_KEY_HERE");
var res = await sdk.Contexts.UpdateAsync(
id: "<id>",
type: "<value>",
updateContextRequestDto: new UpdateContextRequestDto() {
Data = new Dictionary<string, object>() {
{ "tenantName", "Acme Corp" },
{ "region", "us-east-1" },
{ "settings", new Dictionary<string, object>() {
{ "theme", "dark" },
} },
},
}
);
// handle responsedeclare(strict_types=1);
require 'vendor/autoload.php';
use novu;
use novu\Models\Components;
$sdk = novu\Novu::builder()
->setSecurity(
'YOUR_SECRET_KEY_HERE'
)
->build();
$updateContextRequestDto = new Components\UpdateContextRequestDto(
data: [
'tenantName' => 'Acme Corp',
'region' => 'us-east-1',
'settings' => [
'theme' => 'dark',
],
],
);
$response = $sdk->contexts->update(
id: '<id>',
type: '<value>',
updateContextRequestDto: $updateContextRequestDto
);
if ($response->getContextResponseDto !== null) {
// handle response
}from novu_py import Novu
with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = novu.contexts.update(id="<id>", type_="<value>", update_context_request_dto={
"data": {
"tenantName": "Acme Corp",
"region": "us-east-1",
"settings": {
"theme": "dark",
},
},
})
# Handle response
print(res)package main
import(
"context"
"github.com/novuhq/novu-go/v3"
"github.com/novuhq/novu-go/v3/models/components"
"log"
)
func main() {
ctx := context.Background()
s := v3.New(
v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
)
res, err := s.Contexts.Update(ctx, "<id>", "<value>", components.UpdateContextRequestDto{
Data: map[string]any{
"tenantName": "Acme Corp",
"region": "us-east-1",
"settings": map[string]any{
"theme": "dark",
},
},
}, nil)
if err != nil {
log.Fatal(err)
}
if res.GetContextResponseDto != nil {
// handle response
}
}curl --request PATCH \
--url https://api.novu.co/v2/contexts/{type}/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"tenantName": "Acme Corp",
"region": "us-east-1",
"settings": {
"theme": "dark"
}
},
"bridgeUrl": "https://tenant-acme.example.com/api/novu"
}
'const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {tenantName: 'Acme Corp', region: 'us-east-1', settings: {theme: 'dark'}},
bridgeUrl: 'https://tenant-acme.example.com/api/novu'
})
};
fetch('https://api.novu.co/v2/contexts/{type}/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.patch("https://api.novu.co/v2/contexts/{type}/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"tenantName\": \"Acme Corp\",\n \"region\": \"us-east-1\",\n \"settings\": {\n \"theme\": \"dark\"\n }\n },\n \"bridgeUrl\": \"https://tenant-acme.example.com/api/novu\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.novu.co/v2/contexts/{type}/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"tenantName\": \"Acme Corp\",\n \"region\": \"us-east-1\",\n \"settings\": {\n \"theme\": \"dark\"\n }\n },\n \"bridgeUrl\": \"https://tenant-acme.example.com/api/novu\"\n}"
response = http.request(request)
puts response.read_body{
"type": "<string>",
"id": "<string>",
"data": {},
"createdAt": "<string>",
"updatedAt": "<string>",
"bridgeUrl": "<string>"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"errors": {
"fieldName1": {
"messages": [
"Field is required",
"Must be a valid email address"
],
"value": "invalidEmail"
},
"fieldName2": {
"messages": [
"Must be at least 18 years old"
],
"value": 17
},
"fieldName3": {
"messages": [
"Must be a boolean value"
],
"value": true
},
"fieldName4": {
"messages": [
"Must be a valid object"
],
"value": {
"key": "value"
}
},
"fieldName5": {
"messages": [
"Field is missing"
],
"value": null
},
"fieldName6": {
"messages": [
"Undefined value"
]
}
},
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}"API rate limit exceeded"{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}"Please wait some time, then try again."Authorizations
API key authentication. Allowed headers-- "Authorization: ApiKey <novu_secret_key>".
Headers
A header for idempotency purposes
Body
application/json
Custom data to associate with this context. Replaces existing data.
Example:
{ "tenantName": "Acme Corp", "region": "us-east-1", "settings": { "theme": "dark" } }
Optional bridge URL override for agent connect. When an inbound agent turn resolves this context, its bridge call is routed here instead of the agent default bridge URL. Must be a publicly reachable URL. Pass null to clear an existing override.
Example:
"https://tenant-acme.example.com/api/novu"
Response
OK
Context type (e.g., tenant, app, workspace)
Unique identifier for this context
Custom data associated with this context
Creation timestamp
Last update timestamp
Bridge URL override for agent connect, if configured on this context
Was this page helpful?
⌘I
TypeScript
import { Novu } from "@novu/api";
const novu = new Novu({
secretKey: "YOUR_SECRET_KEY_HERE",
});
async function run() {
const result = await novu.contexts.update({
id: "<id>",
type: "<value>",
updateContextRequestDto: {
data: {
"tenantName": "Acme Corp",
"region": "us-east-1",
"settings": {
"theme": "dark",
},
},
bridgeUrl: "https://tenant-acme.example.com/api/novu",
},
});
console.log(result);
}
run();using Novu;
using Novu.Models.Components;
using System.Collections.Generic;
var sdk = new NovuSDK(secretKey: "YOUR_SECRET_KEY_HERE");
var res = await sdk.Contexts.UpdateAsync(
id: "<id>",
type: "<value>",
updateContextRequestDto: new UpdateContextRequestDto() {
Data = new Dictionary<string, object>() {
{ "tenantName", "Acme Corp" },
{ "region", "us-east-1" },
{ "settings", new Dictionary<string, object>() {
{ "theme", "dark" },
} },
},
}
);
// handle responsedeclare(strict_types=1);
require 'vendor/autoload.php';
use novu;
use novu\Models\Components;
$sdk = novu\Novu::builder()
->setSecurity(
'YOUR_SECRET_KEY_HERE'
)
->build();
$updateContextRequestDto = new Components\UpdateContextRequestDto(
data: [
'tenantName' => 'Acme Corp',
'region' => 'us-east-1',
'settings' => [
'theme' => 'dark',
],
],
);
$response = $sdk->contexts->update(
id: '<id>',
type: '<value>',
updateContextRequestDto: $updateContextRequestDto
);
if ($response->getContextResponseDto !== null) {
// handle response
}from novu_py import Novu
with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = novu.contexts.update(id="<id>", type_="<value>", update_context_request_dto={
"data": {
"tenantName": "Acme Corp",
"region": "us-east-1",
"settings": {
"theme": "dark",
},
},
})
# Handle response
print(res)package main
import(
"context"
"github.com/novuhq/novu-go/v3"
"github.com/novuhq/novu-go/v3/models/components"
"log"
)
func main() {
ctx := context.Background()
s := v3.New(
v3.WithSecurity("YOUR_SECRET_KEY_HERE"),
)
res, err := s.Contexts.Update(ctx, "<id>", "<value>", components.UpdateContextRequestDto{
Data: map[string]any{
"tenantName": "Acme Corp",
"region": "us-east-1",
"settings": map[string]any{
"theme": "dark",
},
},
}, nil)
if err != nil {
log.Fatal(err)
}
if res.GetContextResponseDto != nil {
// handle response
}
}curl --request PATCH \
--url https://api.novu.co/v2/contexts/{type}/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"data": {
"tenantName": "Acme Corp",
"region": "us-east-1",
"settings": {
"theme": "dark"
}
},
"bridgeUrl": "https://tenant-acme.example.com/api/novu"
}
'const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {tenantName: 'Acme Corp', region: 'us-east-1', settings: {theme: 'dark'}},
bridgeUrl: 'https://tenant-acme.example.com/api/novu'
})
};
fetch('https://api.novu.co/v2/contexts/{type}/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.patch("https://api.novu.co/v2/contexts/{type}/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"tenantName\": \"Acme Corp\",\n \"region\": \"us-east-1\",\n \"settings\": {\n \"theme\": \"dark\"\n }\n },\n \"bridgeUrl\": \"https://tenant-acme.example.com/api/novu\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.novu.co/v2/contexts/{type}/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"tenantName\": \"Acme Corp\",\n \"region\": \"us-east-1\",\n \"settings\": {\n \"theme\": \"dark\"\n }\n },\n \"bridgeUrl\": \"https://tenant-acme.example.com/api/novu\"\n}"
response = http.request(request)
puts response.read_body{
"type": "<string>",
"id": "<string>",
"data": {},
"createdAt": "<string>",
"updatedAt": "<string>",
"bridgeUrl": "<string>"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"errors": {
"fieldName1": {
"messages": [
"Field is required",
"Must be a valid email address"
],
"value": "invalidEmail"
},
"fieldName2": {
"messages": [
"Must be at least 18 years old"
],
"value": 17
},
"fieldName3": {
"messages": [
"Must be a boolean value"
],
"value": true
},
"fieldName4": {
"messages": [
"Must be a valid object"
],
"value": {
"key": "value"
}
},
"fieldName5": {
"messages": [
"Field is missing"
],
"value": null
},
"fieldName6": {
"messages": [
"Undefined value"
]
}
},
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}"API rate limit exceeded"{
"statusCode": 404,
"timestamp": "2024-12-12T13:00:00Z",
"path": "/api/v1/resource",
"message": "xx xx xx ",
"ctx": {
"workflowId": "some_wf_id",
"stepId": "some_wf_id"
},
"errorId": "abc123"
}"Please wait some time, then try again."