Inquirly
  1. Help Center
Inquirly
  • Accounts
    • Create an Account
      POST
    • Get an account details
      GET
    • Update an account
      PATCH
    • Delete an Account
      DELETE
  • Account Users
    • List all Account Users
      GET
    • Create an Account User
      POST
    • Delete an Account User
      DELETE
  • AgentBots
    • List all AgentBots
      GET
    • Create an Agent Bot
      POST
    • Get an agent bot details
      GET
    • Update an agent bot
      PATCH
    • Delete an AgentBot
      DELETE
  • Users
    • Create a User
      POST
    • Get an user details
      GET
    • Update a user
      PATCH
    • Delete a User
      DELETE
    • Get User SSO Link
      GET
  • Inbox API
    • Inbox details
      GET
  • Contacts API
    • Create a contact
      POST
    • Get a contact
      GET
    • Update a contact
      PATCH
  • Conversations API
    • Create a conversation
    • List all conversations
    • Get a single conversation
    • Resolve a conversation
    • Toggle typing status
    • Update last seen
  • Messages API
    • Create a message
    • List all messages
    • Update a message
  • Contact Labels
    • List Labels
    • Add Labels
  • CSAT Survey Page
    • Get CSAT survey page
  • Account AgentBots
    • List all AgentBots
    • Create an Agent Bot
    • Get an agent bot details
    • Update an agent bot
    • Delete an AgentBot
  • Agents
    • List Agents in Account
    • Add a New Agent
    • Update Agent in Account
    • Remove an Agent from Account
  • Canned Responses
    • List all Canned Responses in an Account
    • Add a New Canned Response
    • Remove a Canned Response from Account
  • Canned Response
    • Update Canned Response in Account
  • Custom Attributes
    • List all custom attributes in an account
    • Add a new custom attribute
    • Get a custom attribute details
    • Update custom attribute in Account
    • Remove a custom attribute from account
  • Contacts
    • List Contacts
    • Create Contact
    • Show Contact
    • Update Contact
    • Delete Contact
    • Contact Conversations
    • Search Contacts
    • Contact Filter
  • Contact
    • Create contact inbox
    • Get Contactable Inboxes
  • Automation Rule
    • List all automation rules in an account
    • Add a new automation rule
    • Get a automation rule details
    • Update automation rule in Account
    • Remove a automation rule from account
  • Help Center
    • Add a new portal
      POST
    • List all portals in an account
      GET
    • update a new portal
      PATCH
    • Add a new category
      POST
    • Add a new article
      POST
  • Conversations
    • Get Conversation Counts
    • Conversations List
    • Create New Conversation
    • Conversations Filter
    • Conversation Details
    • Update Conversation
    • Toggle Status
    • Toggle Priority
  • Conversation Assignment
    • Assign Conversation
  • Conversation Labels
    • List Labels
    • Add Labels
  • Inboxes
    • List all inboxes
    • Get an inbox
    • Create an inbox
    • Update Inbox
    • Show Inbox Agent Bot
    • Add or remove agent bot
    • List Agents in Inbox
    • Add a New Agent
    • Update Agents in Inbox
    • Remove an Agent from Inbox
  • Messages
    • Get messages
    • Create New Message
    • Delete a message
  • Integrations
    • List all the Integrations
    • Create an integration hook
    • Update an Integration Hook
    • Delete an Integration Hook
  • Profile
    • Fetch user profile
  • Teams
    • List all teams
    • Create a team
    • Get a team details
    • Update a team
    • Delete a team
    • List Agents in Team
    • Add a New Agent
    • Update Agents in Team
    • Remove an Agent from Team
  • Custom Filters
    • List all custom filters
    • Create a custom filter
    • Get a custom filter details
    • Update a custom filter
    • Delete a custom filter
  • Webhooks
    • List all webhooks
    • Add a webhook
    • Update a webhook object
    • Delete a webhook
  • Reports
    • Get Account reports
    • Get Account reports summary
    • Account Conversation Metrics
    • Agent Conversation Metrics
  1. Help Center

update a new portal

PATCH
/api/v1/accounts/{account_id}/portals
Help Center
update a new portal to account
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH '/api/v1/accounts//portals' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "archived": true,
    "color": "add color HEX string, \"#fffff\"",
    "config": {
        "allowed_locales": [
            "en",
            "es"
        ],
        "default_locale": "en"
    },
    "custom_domain": "https://chatwoot.help/.",
    "header_text": "Handbook",
    "homepage_link": "https://www.chatwoot.com/",
    "name": "string",
    "slug": "string",
    "page_title": "string",
    "account_id": 0
}'
Response Response Example
200 - Example 1
{
    "id": 0,
    "archived": true,
    "color": "string",
    "config": {},
    "custom_domain": "string",
    "header_text": "string",
    "homepage_link": "string",
    "name": "string",
    "slug": "string",
    "page_title": "string",
    "account_id": 0,
    "categories": [
        {
            "id": 0,
            "description": "string",
            "locale": "string",
            "name": "string",
            "slug": "string",
            "position": 0,
            "portal_id": 0,
            "account_id": 0,
            "associated_category_id": 0,
            "parent_category_id": 0
        }
    ],
    "articles": [
        {
            "id": 0,
            "content": "string",
            "meta": {},
            "position": 0,
            "status": "draft",
            "title": "string",
            "slug": "string",
            "views": 0,
            "portal_id": 0,
            "account_id": 0,
            "author_id": 0,
            "category_id": 0,
            "folder_id": 0,
            "associated_article_id": 0
        }
    ]
}

Request

Path Params
account_id
string 
required
Body Params application/json; charset=utf-8
archived
boolean 
optional
Status to check if portal is live
color
string 
optional
Header color for help-center
Example:
add color HEX string, "#fffff"
config
object 
optional
Configuration about supporting locales
Example:
{"allowed_locales":["en","es"],"default_locale":"en"}
custom_domain
string 
optional
Custom domain to display help center.
Example:
https://chatwoot.help/.
header_text
string 
optional
Help center header
Example:
Handbook
homepage_link
string 
optional
link to main dashboard
Example:
https://www.chatwoot.com/
name
string 
optional
Name for the portal
slug
string 
optional
Slug for the portal to display in link
page_title
string 
optional
Page title for the portal
account_id
integer 
optional
Examples

Responses

🟢200OK
application/json; charset=utf-8
Success
Body
id
integer 
optional
archived
boolean 
optional
color
string 
optional
config
object 
optional
Save information about locales, allowed_locales and default portal/help-center locale
custom_domain
string 
optional
header_text
string 
optional
The text content.
homepage_link
string 
optional
name
string 
optional
slug
string 
optional
page_title
string 
optional
account_id
integer 
optional
categories
array[object (category) {10}] 
optional
id
integer 
optional
description
string 
optional
The text content.
locale
string 
optional
name
string 
optional
slug
string 
optional
position
integer 
optional
portal_id
integer 
optional
account_id
integer 
optional
associated_category_id
integer 
optional
To associate similar categories to each other, e.g same category of product documentation in different languages
parent_category_id
integer 
optional
To define parent category, e.g product documentation has multiple level features in sales category or in engineering category.
articles
array[object (article) {14}] 
optional
id
integer 
optional
content
string 
optional
The text content.
meta
object 
optional
position
integer 
optional
status
enum<integer> 
optional
Allowed values:
draftpublishedarchived
title
string 
optional
slug
string 
optional
views
integer 
optional
portal_id
integer 
optional
account_id
integer 
optional
author_id
integer 
optional
category_id
integer 
optional
folder_id
integer 
optional
associated_article_id
integer 
optional
To associate similar articles to each other, e.g to provide the link for the reference.
🟠403Forbidden
Previous
List all portals in an account
Next
Add a new category
Built with