Skip to main content
POST
Add a new portal

Authorizations

api_access_token
string
header
required

Token de usuario. Envía el valor en el header api_access_token. Lo obtienes en el perfil (GET /api/v1/profile) o al regenerarlo.

Path Parameters

account_id
integer
required

The numeric ID of the account

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:

"yampi.ai.help"

header_text
string

Help center header

Example:

"Handbook"

link to main dashboard

Example:

"https://yampi.ai/"

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:

Response

Success

payload
object[]