Portals

Update Portal

Update portal

post
/v1/portal/{portalId}/update

Authorization

ChatBotKit API Secret * Required

HTTP Authorization Scheme: bearer

Path Parameters

portalIdstring* Required

Request Body * Required

Request Body Schema: application/json

namestring

The associated name

descriptionstring

The associated description

metaobject

Meta data information

blueprintIdstring

The ID of the blueprint

slugstring

The slug for the portal

configobject

The config for the portal

import { ChatBotKit } from '@chatbotkit/sdk'

const cbk = new ChatBotKit({

secret: process.env.CHATBOTKIT_API_KEY!

})

const response = await cbk.portal.update(

portalId,
{
"name":"string",
"description":"string",
"meta":"object",
"blueprintId":"string",
"slug":"string",
"config":"object"
}
)
{
"id":"string"
}
The portal was updated successfully