Add a new category

POST

api

accounts

{account_id}

portals

{id}

categories

Add a new category

curl --request POST \
  --url https://app.tied.com/api/v1/accounts/{account_id}/portals/{id}/categories \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "name": "Category Name",
  "description": "Category description",
  "position": 1,
  "slug": "category-name",
  "locale": "en",
  "icon": "📚",
  "parent_category_id": 1,
  "associated_category_id": 2
}
'

import requests

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

payload = {
    "name": "Category Name",
    "description": "Category description",
    "position": 1,
    "slug": "category-name",
    "locale": "en",
    "icon": "📚",
    "parent_category_id": 1,
    "associated_category_id": 2
}
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Category Name',
    description: 'Category description',
    position: 1,
    slug: 'category-name',
    locale: 'en',
    icon: '📚',
    parent_category_id: 1,
    associated_category_id: 2
  })
};

fetch('https://app.tied.com/api/v1/accounts/{account_id}/portals/{id}/categories', 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}/categories")

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

request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Category Name\",\n  \"description\": \"Category description\",\n  \"position\": 1,\n  \"slug\": \"category-name\",\n  \"locale\": \"en\",\n  \"icon\": \"📚\",\n  \"parent_category_id\": 1,\n  \"associated_category_id\": 2\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}/categories"

	payload := strings.NewReader("{\n  \"name\": \"Category Name\",\n  \"description\": \"Category description\",\n  \"position\": 1,\n  \"slug\": \"category-name\",\n  \"locale\": \"en\",\n  \"icon\": \"📚\",\n  \"parent_category_id\": 1,\n  \"associated_category_id\": 2\n}")

	req, _ := http.NewRequest("POST", 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))

}

{
  "payload": {
    "id": 16,
    "name": "Integrations",
    "slug": "integrations",
    "locale": "en",
    "description": "Connecting Tied to the tools your team already runs on.",
    "position": null,
    "account_id": 1,
    "icon": "",
    "meta": {
      "articles_count": 0
    }
  }
}

{
  "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

name

string

The name of the category

Example:

"Category Name"

description

string

A description for the category

Example:

"Category description"

position

integer

Category position in the portal list to sort

Example:

1

slug

string

The category slug used in the URL

Example:

"category-name"

locale

string

The locale of the category

Example:

"en"

icon

string

The icon of the category as a string (emoji)

Example:

"📚"

parent_category_id

integer

To define parent category, e.g product documentation has multiple level features in sales category or in engineering category.

Example:

1

associated_category_id

integer

To associate similar categories to each other, e.g same category of product documentation in different languages

Example:

2

Response

Success

Single-category responses are wrapped in a payload key.

payload

object

Show child attributes

Add a new category

curl --request POST \
  --url https://app.tied.com/api/v1/accounts/{account_id}/portals/{id}/categories \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "name": "Category Name",
  "description": "Category description",
  "position": 1,
  "slug": "category-name",
  "locale": "en",
  "icon": "📚",
  "parent_category_id": 1,
  "associated_category_id": 2
}
'

import requests

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

payload = {
    "name": "Category Name",
    "description": "Category description",
    "position": 1,
    "slug": "category-name",
    "locale": "en",
    "icon": "📚",
    "parent_category_id": 1,
    "associated_category_id": 2
}
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Category Name',
    description: 'Category description',
    position: 1,
    slug: 'category-name',
    locale: 'en',
    icon: '📚',
    parent_category_id: 1,
    associated_category_id: 2
  })
};

fetch('https://app.tied.com/api/v1/accounts/{account_id}/portals/{id}/categories', 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}/categories")

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

request = Net::HTTP::Post.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Category Name\",\n  \"description\": \"Category description\",\n  \"position\": 1,\n  \"slug\": \"category-name\",\n  \"locale\": \"en\",\n  \"icon\": \"📚\",\n  \"parent_category_id\": 1,\n  \"associated_category_id\": 2\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}/categories"

	payload := strings.NewReader("{\n  \"name\": \"Category Name\",\n  \"description\": \"Category description\",\n  \"position\": 1,\n  \"slug\": \"category-name\",\n  \"locale\": \"en\",\n  \"icon\": \"📚\",\n  \"parent_category_id\": 1,\n  \"associated_category_id\": 2\n}")

	req, _ := http.NewRequest("POST", 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))

}

{
  "payload": {
    "id": 16,
    "name": "Integrations",
    "slug": "integrations",
    "locale": "en",
    "description": "Connecting Tied to the tools your team already runs on.",
    "position": null,
    "account_id": 1,
    "icon": "",
    "meta": {
      "articles_count": 0
    }
  }
}

{
  "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

Add a new category

Authorizations

Path Parameters

Body

Response