Update a portal

Updates the portal. Every field is optional, and portal itself may be omitted entirely when you are only attaching a logo with blob_id.

Archiving is done here, by sending archived: true — it is what takes a portal off the public Help Center without deleting it.

custom_domain is accepted by the parameter filter but not applied — the assignment is commented out in the controller, so a custom domain cannot currently be changed through the API after the portal is created.

PATCH

api

accounts

{account_id}

portals

{id}

Update a portal

curl --request PATCH \
  --url https://app.tied.com/api/v1/accounts/{account_id}/portals/{id} \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "color": "#FFFFFF",
  "custom_domain": "tied.help",
  "header_text": "Handbook",
  "homepage_link": "https://tied.com/",
  "name": "Handbook",
  "page_title": "Handbook",
  "slug": "handbook",
  "archived": false,
  "config": {
    "allowed_locales": [
      "en",
      "es"
    ],
    "default_locale": "en"
  }
}
'

import requests

url = "https://app.tied.com/api/v1/accounts/{account_id}/portals/{id}"

payload = {
    "color": "#FFFFFF",
    "custom_domain": "tied.help",
    "header_text": "Handbook",
    "homepage_link": "https://tied.com/",
    "name": "Handbook",
    "page_title": "Handbook",
    "slug": "handbook",
    "archived": False,
    "config": {
        "allowed_locales": ["en", "es"],
        "default_locale": "en"
    }
}
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    color: '#FFFFFF',
    custom_domain: 'tied.help',
    header_text: 'Handbook',
    homepage_link: 'https://tied.com/',
    name: 'Handbook',
    page_title: 'Handbook',
    slug: 'handbook',
    archived: false,
    config: {allowed_locales: ['en', 'es'], default_locale: 'en'}
  })
};

fetch('https://app.tied.com/api/v1/accounts/{account_id}/portals/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://app.tied.com/api/v1/accounts/{account_id}/portals/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"color\": \"#FFFFFF\",\n  \"custom_domain\": \"tied.help\",\n  \"header_text\": \"Handbook\",\n  \"homepage_link\": \"https://tied.com/\",\n  \"name\": \"Handbook\",\n  \"page_title\": \"Handbook\",\n  \"slug\": \"handbook\",\n  \"archived\": false,\n  \"config\": {\n    \"allowed_locales\": [\n      \"en\",\n      \"es\"\n    ],\n    \"default_locale\": \"en\"\n  }\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.tied.com/api/v1/accounts/{account_id}/portals/{id}"

	payload := strings.NewReader("{\n  \"color\": \"#FFFFFF\",\n  \"custom_domain\": \"tied.help\",\n  \"header_text\": \"Handbook\",\n  \"homepage_link\": \"https://tied.com/\",\n  \"name\": \"Handbook\",\n  \"page_title\": \"Handbook\",\n  \"slug\": \"handbook\",\n  \"archived\": false,\n  \"config\": {\n    \"allowed_locales\": [\n      \"en\",\n      \"es\"\n    ],\n    \"default_locale\": \"en\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("api_access_token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": 1,
  "color": null,
  "custom_domain": null,
  "header_text": "Answers, guides and troubleshooting for the Tied platform.",
  "homepage_link": null,
  "name": "Tied Help Center",
  "page_title": "Tied Help Center",
  "slug": "tied-help",
  "archived": false,
  "account_id": 1,
  "config": {
    "allowed_locales": [
      {
        "code": "en",
        "articles_count": 7,
        "categories_count": 3
      }
    ]
  },
  "meta": {
    "all_articles_count": 0,
    "archived_articles_count": null,
    "published_count": null,
    "draft_articles_count": null,
    "categories_count": 3,
    "default_locale": "en"
  }
}

{
  "error": "Resource could not be found"
}

{
  "error": "Resource could not be found"
}

{
  "message": "Url has already been taken",
  "attributes": [
    "url"
  ]
}

Authorizations

api_access_token

string

header

required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

string

required

The slug identifier of the portal

Body

application/json

color

string

Header color for help-center in hex format

Example:

"#FFFFFF"

custom_domain

string

Custom domain to display help center.

Example:

"tied.help"

header_text

string

Help center header

Example:

"Handbook"

homepage_link

string

link to main dashboard

Example:

"https://tied.com/"

name

string

Name for the portal

Example:

"Handbook"

page_title

string

Page title for the portal

Example:

"Handbook"

slug

string

Slug for the portal to display in link

Example:

"handbook"

archived

boolean

Status to check if portal is live

Example:

false

config

object

Configuration about supporting locales

Example:

{
  "allowed_locales": ["en", "es"],
  "default_locale": "en"
}

Response

Success

integer

The ID of the portal

archived

boolean

Whether the portal is archived

color

string | null

The color code for the portal

config

object

Configuration settings for the portal

Show child attributes

custom_domain

string | null

Custom domain for the portal

header_text

string | null

The header text for the portal

homepage_link

string | null

Homepage link for the portal

name

string

Name of the portal

slug

string

URL slug for the portal

page_title

string | null

Page title for the portal

account_id

integer

ID of the account the portal belongs to

inbox

object

Show child attributes

logo

object

Show child attributes

meta

object

Show child attributes

Update a portal

curl --request PATCH \
  --url https://app.tied.com/api/v1/accounts/{account_id}/portals/{id} \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "color": "#FFFFFF",
  "custom_domain": "tied.help",
  "header_text": "Handbook",
  "homepage_link": "https://tied.com/",
  "name": "Handbook",
  "page_title": "Handbook",
  "slug": "handbook",
  "archived": false,
  "config": {
    "allowed_locales": [
      "en",
      "es"
    ],
    "default_locale": "en"
  }
}
'

import requests

url = "https://app.tied.com/api/v1/accounts/{account_id}/portals/{id}"

payload = {
    "color": "#FFFFFF",
    "custom_domain": "tied.help",
    "header_text": "Handbook",
    "homepage_link": "https://tied.com/",
    "name": "Handbook",
    "page_title": "Handbook",
    "slug": "handbook",
    "archived": False,
    "config": {
        "allowed_locales": ["en", "es"],
        "default_locale": "en"
    }
}
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    color: '#FFFFFF',
    custom_domain: 'tied.help',
    header_text: 'Handbook',
    homepage_link: 'https://tied.com/',
    name: 'Handbook',
    page_title: 'Handbook',
    slug: 'handbook',
    archived: false,
    config: {allowed_locales: ['en', 'es'], default_locale: 'en'}
  })
};

fetch('https://app.tied.com/api/v1/accounts/{account_id}/portals/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://app.tied.com/api/v1/accounts/{account_id}/portals/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"color\": \"#FFFFFF\",\n  \"custom_domain\": \"tied.help\",\n  \"header_text\": \"Handbook\",\n  \"homepage_link\": \"https://tied.com/\",\n  \"name\": \"Handbook\",\n  \"page_title\": \"Handbook\",\n  \"slug\": \"handbook\",\n  \"archived\": false,\n  \"config\": {\n    \"allowed_locales\": [\n      \"en\",\n      \"es\"\n    ],\n    \"default_locale\": \"en\"\n  }\n}"

response = http.request(request)
puts response.read_body

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.tied.com/api/v1/accounts/{account_id}/portals/{id}"

	payload := strings.NewReader("{\n  \"color\": \"#FFFFFF\",\n  \"custom_domain\": \"tied.help\",\n  \"header_text\": \"Handbook\",\n  \"homepage_link\": \"https://tied.com/\",\n  \"name\": \"Handbook\",\n  \"page_title\": \"Handbook\",\n  \"slug\": \"handbook\",\n  \"archived\": false,\n  \"config\": {\n    \"allowed_locales\": [\n      \"en\",\n      \"es\"\n    ],\n    \"default_locale\": \"en\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("api_access_token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "id": 1,
  "color": null,
  "custom_domain": null,
  "header_text": "Answers, guides and troubleshooting for the Tied platform.",
  "homepage_link": null,
  "name": "Tied Help Center",
  "page_title": "Tied Help Center",
  "slug": "tied-help",
  "archived": false,
  "account_id": 1,
  "config": {
    "allowed_locales": [
      {
        "code": "en",
        "articles_count": 7,
        "categories_count": 3
      }
    ]
  },
  "meta": {
    "all_articles_count": 0,
    "archived_articles_count": null,
    "published_count": null,
    "draft_articles_count": null,
    "categories_count": 3,
    "default_locale": "en"
  }
}

{
  "error": "Resource could not be found"
}

{
  "error": "Resource could not be found"
}

{
  "message": "Url has already been taken",
  "attributes": [
    "url"
  ]
}

Getting started

Conversations

Contacts

Inboxes and channels

Automation and routing

Reporting

Help Center

Account and access

Billing

Client API

Widget API

Receiving webhooks

Update a portal

Authorizations

Path Parameters

Body

Response