Help center

Update a portal

Update a portal to account

patch/v1/workspaces/{workspace_id}/portals/{id}

Request

  • Base URL: https://api.oxvo.com
  • URL: https://api.oxvo.com/v1/workspaces/{workspace_id}/portals/{id}
  • Auth: API key in header api_access_token

Path parameters

workspace_idinteger required

The numeric ID of the workspace

idstring required

The slug identifier of the portal

Request body

colorstring

Header color for help-center in hex format

custom_domainstring

Custom domain to display help center.

header_textstring

Help center header

homepage_linkstring

link to main dashboard

namestring

Name for the portal

page_titlestring

Page title for the portal

slugstring

Slug for the portal to display in link

archivedboolean

Status to check if portal is live

configobject

Configuration about supporting locales

Example request

{
  "color": "#FFFFFF",
  "custom_domain": "oxvo.help",
  "header_text": "Handbook",
  "homepage_link": "https://www.oxvo.com/",
  "name": "Handbook",
  "page_title": "Handbook",
  "slug": "handbook",
  "config": {
    "allowed_locales": [
      "en",
      "es"
    ],
    "default_locale": "en"
  }
}

Response

Success

Changes

No recorded changes to this operation across all 1 revision of this API.