Channel Connections
Update a channel connection
Update an existing channel connection by its unique identifier.
PATCH
/
v1
/
channel-connections
/
{identifier}
Go
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.ChannelConnections.Update(ctx, "<value>", components.UpdateChannelConnectionRequestDto{
Workspace: components.WorkspaceDto{
ID: "T123456",
Name: v3.Pointer("Acme HQ"),
BotUserID: v3.Pointer("U0123456789"),
},
Auth: components.AuthDto{
AccessToken: "Workspace access token",
RefreshToken: v3.Pointer("Workspace refresh token"),
ExpiresAt: v3.Pointer("2026-06-15T12:00:00.000Z"),
RefreshTokenExpiresAt: v3.Pointer("2026-09-15T12:00:00.000Z"),
},
}, nil)
if err != nil {
log.Fatal(err)
}
if res.GetChannelConnectionResponseDto != nil {
// handle response
}
}import { Novu } from "@novu/api";
const novu = new Novu({
secretKey: "YOUR_SECRET_KEY_HERE",
});
async function run() {
const result = await novu.channelConnections.update({
workspace: {
id: "T123456",
name: "Acme HQ",
botUserId: "U0123456789",
},
auth: {
accessToken: "Workspace access token",
refreshToken: "Workspace refresh token",
expiresAt: "2026-06-15T12:00:00.000Z",
refreshTokenExpiresAt: "2026-09-15T12:00:00.000Z",
},
}, "<value>");
console.log(result);
}
run();using Novu;
using Novu.Models.Components;
var sdk = new NovuSDK(secretKey: "YOUR_SECRET_KEY_HERE");
var res = await sdk.ChannelConnections.UpdateAsync(
identifier: "<value>",
updateChannelConnectionRequestDto: new UpdateChannelConnectionRequestDto() {
Workspace = new WorkspaceDto() {
Id = "T123456",
Name = "Acme HQ",
BotUserId = "U0123456789",
},
Auth = new AuthDto() {
AccessToken = "Workspace access token",
RefreshToken = "Workspace refresh token",
ExpiresAt = "2026-06-15T12:00:00.000Z",
RefreshTokenExpiresAt = "2026-09-15T12:00:00.000Z",
},
}
);
// 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();
$updateChannelConnectionRequestDto = new Components\UpdateChannelConnectionRequestDto(
workspace: new Components\WorkspaceDto(
id: 'T123456',
name: 'Acme HQ',
botUserId: 'U0123456789',
),
auth: new Components\AuthDto(
accessToken: 'Workspace access token',
refreshToken: 'Workspace refresh token',
expiresAt: '2026-06-15T12:00:00.000Z',
refreshTokenExpiresAt: '2026-09-15T12:00:00.000Z',
),
);
$response = $sdk->channelConnections->update(
identifier: '<value>',
updateChannelConnectionRequestDto: $updateChannelConnectionRequestDto
);
if ($response->getChannelConnectionResponseDto !== null) {
// handle response
}from novu_py import Novu
with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = novu.channel_connections.update(identifier="<value>", update_channel_connection_request_dto={
"workspace": {
"id": "T123456",
"name": "Acme HQ",
"bot_user_id": "U0123456789",
},
"auth": {
"access_token": "Workspace access token",
"refresh_token": "Workspace refresh token",
"expires_at": "2026-06-15T12:00:00.000Z",
"refresh_token_expires_at": "2026-09-15T12:00:00.000Z",
},
})
# Handle response
print(res)curl --request PATCH \
--url https://api.novu.co/v1/channel-connections/{identifier} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"workspace": {
"id": "T123456",
"name": "Acme HQ",
"botUserId": "U0123456789"
},
"auth": {
"accessToken": "Workspace access token",
"refreshToken": "Workspace refresh token",
"expiresAt": "2026-06-15T12:00:00.000Z",
"refreshTokenExpiresAt": "2026-09-15T12:00:00.000Z"
}
}
'const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workspace: {id: 'T123456', name: 'Acme HQ', botUserId: 'U0123456789'},
auth: {
accessToken: 'Workspace access token',
refreshToken: 'Workspace refresh token',
expiresAt: '2026-06-15T12:00:00.000Z',
refreshTokenExpiresAt: '2026-09-15T12:00:00.000Z'
}
})
};
fetch('https://api.novu.co/v1/channel-connections/{identifier}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.patch("https://api.novu.co/v1/channel-connections/{identifier}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workspace\": {\n \"id\": \"T123456\",\n \"name\": \"Acme HQ\",\n \"botUserId\": \"U0123456789\"\n },\n \"auth\": {\n \"accessToken\": \"Workspace access token\",\n \"refreshToken\": \"Workspace refresh token\",\n \"expiresAt\": \"2026-06-15T12:00:00.000Z\",\n \"refreshTokenExpiresAt\": \"2026-09-15T12:00:00.000Z\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.novu.co/v1/channel-connections/{identifier}")
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 \"workspace\": {\n \"id\": \"T123456\",\n \"name\": \"Acme HQ\",\n \"botUserId\": \"U0123456789\"\n },\n \"auth\": {\n \"accessToken\": \"Workspace access token\",\n \"refreshToken\": \"Workspace refresh token\",\n \"expiresAt\": \"2026-06-15T12:00:00.000Z\",\n \"refreshTokenExpiresAt\": \"2026-09-15T12:00:00.000Z\"\n }\n}"
response = http.request(request)
puts response.read_body{
"identifier": "<string>",
"channel": "in_app",
"providerId": "slack",
"integrationIdentifier": "slack-prod",
"subscriberId": "subscriber-123",
"contextKeys": [
"tenant:org-123",
"region:us-east-1"
],
"workspace": {
"id": "T123456",
"name": "Acme HQ",
"botUserId": "U0123456789"
},
"auth": {
"accessToken": "Workspace access token",
"refreshToken": "Workspace refresh token",
"expiresAt": "2026-06-15T12:00:00.000Z",
"refreshTokenExpiresAt": "2026-09-15T12:00:00.000Z"
},
"createdAt": "<string>",
"updatedAt": "<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
Body
application/json
Response
OK
The provider identifier (e.g., sendgrid, twilio, slack, etc.).
Available options:
anypost, emailjs, mailgun, mailjet, mandrill, nodemailer, postmark, sendgrid, sendinblue, ses, netcore, infobip-email, resend, plunk, mailersend, mailtrap, clickatell, outlook365, novu-email, sparkpost, email-webhook, braze, novu-email-agent, nexmo, plivo, sms77, sms-central, sns, telnyx, twilio, gupshup, firetext, infobip-sms, burst-sms, bulk-sms, isend-sms, forty-six-elks, kannel, maqsam, termii, africas-talking, novu-sms, sendchamp, generic-sms, clicksend, bandwidth, messagebird, simpletexting, azure-sms, ring-central, brevo-sms, eazy-sms, mobishastra, afro-message, unifonic, smsmode, imedia, sinch, isendpro-sms, cm-telecom, ruach-sms, fcm, apns, expo, one-signal, pushpad, push-webhook, pusher-beams, appio, novu, slack, discord, msteams, webex-messaging, mattermost, ryver, zulip, grafana-on-call, getstream, rocket-chat, whatsapp-business, line, chat-webhook, novu-slack, telegram, sendblue, novu-web-chat, anthropic, novu-anthropic, anthropic-aws, pagerduty, opsgenie, grafana, tool-webhook Example:
"slack"
Was this page helpful?
⌘I
Go
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.ChannelConnections.Update(ctx, "<value>", components.UpdateChannelConnectionRequestDto{
Workspace: components.WorkspaceDto{
ID: "T123456",
Name: v3.Pointer("Acme HQ"),
BotUserID: v3.Pointer("U0123456789"),
},
Auth: components.AuthDto{
AccessToken: "Workspace access token",
RefreshToken: v3.Pointer("Workspace refresh token"),
ExpiresAt: v3.Pointer("2026-06-15T12:00:00.000Z"),
RefreshTokenExpiresAt: v3.Pointer("2026-09-15T12:00:00.000Z"),
},
}, nil)
if err != nil {
log.Fatal(err)
}
if res.GetChannelConnectionResponseDto != nil {
// handle response
}
}import { Novu } from "@novu/api";
const novu = new Novu({
secretKey: "YOUR_SECRET_KEY_HERE",
});
async function run() {
const result = await novu.channelConnections.update({
workspace: {
id: "T123456",
name: "Acme HQ",
botUserId: "U0123456789",
},
auth: {
accessToken: "Workspace access token",
refreshToken: "Workspace refresh token",
expiresAt: "2026-06-15T12:00:00.000Z",
refreshTokenExpiresAt: "2026-09-15T12:00:00.000Z",
},
}, "<value>");
console.log(result);
}
run();using Novu;
using Novu.Models.Components;
var sdk = new NovuSDK(secretKey: "YOUR_SECRET_KEY_HERE");
var res = await sdk.ChannelConnections.UpdateAsync(
identifier: "<value>",
updateChannelConnectionRequestDto: new UpdateChannelConnectionRequestDto() {
Workspace = new WorkspaceDto() {
Id = "T123456",
Name = "Acme HQ",
BotUserId = "U0123456789",
},
Auth = new AuthDto() {
AccessToken = "Workspace access token",
RefreshToken = "Workspace refresh token",
ExpiresAt = "2026-06-15T12:00:00.000Z",
RefreshTokenExpiresAt = "2026-09-15T12:00:00.000Z",
},
}
);
// 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();
$updateChannelConnectionRequestDto = new Components\UpdateChannelConnectionRequestDto(
workspace: new Components\WorkspaceDto(
id: 'T123456',
name: 'Acme HQ',
botUserId: 'U0123456789',
),
auth: new Components\AuthDto(
accessToken: 'Workspace access token',
refreshToken: 'Workspace refresh token',
expiresAt: '2026-06-15T12:00:00.000Z',
refreshTokenExpiresAt: '2026-09-15T12:00:00.000Z',
),
);
$response = $sdk->channelConnections->update(
identifier: '<value>',
updateChannelConnectionRequestDto: $updateChannelConnectionRequestDto
);
if ($response->getChannelConnectionResponseDto !== null) {
// handle response
}from novu_py import Novu
with Novu(
secret_key="YOUR_SECRET_KEY_HERE",
) as novu:
res = novu.channel_connections.update(identifier="<value>", update_channel_connection_request_dto={
"workspace": {
"id": "T123456",
"name": "Acme HQ",
"bot_user_id": "U0123456789",
},
"auth": {
"access_token": "Workspace access token",
"refresh_token": "Workspace refresh token",
"expires_at": "2026-06-15T12:00:00.000Z",
"refresh_token_expires_at": "2026-09-15T12:00:00.000Z",
},
})
# Handle response
print(res)curl --request PATCH \
--url https://api.novu.co/v1/channel-connections/{identifier} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"workspace": {
"id": "T123456",
"name": "Acme HQ",
"botUserId": "U0123456789"
},
"auth": {
"accessToken": "Workspace access token",
"refreshToken": "Workspace refresh token",
"expiresAt": "2026-06-15T12:00:00.000Z",
"refreshTokenExpiresAt": "2026-09-15T12:00:00.000Z"
}
}
'const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workspace: {id: 'T123456', name: 'Acme HQ', botUserId: 'U0123456789'},
auth: {
accessToken: 'Workspace access token',
refreshToken: 'Workspace refresh token',
expiresAt: '2026-06-15T12:00:00.000Z',
refreshTokenExpiresAt: '2026-09-15T12:00:00.000Z'
}
})
};
fetch('https://api.novu.co/v1/channel-connections/{identifier}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.patch("https://api.novu.co/v1/channel-connections/{identifier}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workspace\": {\n \"id\": \"T123456\",\n \"name\": \"Acme HQ\",\n \"botUserId\": \"U0123456789\"\n },\n \"auth\": {\n \"accessToken\": \"Workspace access token\",\n \"refreshToken\": \"Workspace refresh token\",\n \"expiresAt\": \"2026-06-15T12:00:00.000Z\",\n \"refreshTokenExpiresAt\": \"2026-09-15T12:00:00.000Z\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.novu.co/v1/channel-connections/{identifier}")
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 \"workspace\": {\n \"id\": \"T123456\",\n \"name\": \"Acme HQ\",\n \"botUserId\": \"U0123456789\"\n },\n \"auth\": {\n \"accessToken\": \"Workspace access token\",\n \"refreshToken\": \"Workspace refresh token\",\n \"expiresAt\": \"2026-06-15T12:00:00.000Z\",\n \"refreshTokenExpiresAt\": \"2026-09-15T12:00:00.000Z\"\n }\n}"
response = http.request(request)
puts response.read_body{
"identifier": "<string>",
"channel": "in_app",
"providerId": "slack",
"integrationIdentifier": "slack-prod",
"subscriberId": "subscriber-123",
"contextKeys": [
"tenant:org-123",
"region:us-east-1"
],
"workspace": {
"id": "T123456",
"name": "Acme HQ",
"botUserId": "U0123456789"
},
"auth": {
"accessToken": "Workspace access token",
"refreshToken": "Workspace refresh token",
"expiresAt": "2026-06-15T12:00:00.000Z",
"refreshTokenExpiresAt": "2026-09-15T12:00:00.000Z"
},
"createdAt": "<string>",
"updatedAt": "<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."