Pular para o conteúdo principal
POST
/
url-mappings
/
2026-03
/
url-mappings
Criar mapeamento de URL
curl --request POST \
  --url https://api.hubapi.com/url-mappings/2026-03/url-mappings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: */*' \
  --data '
{
  "cdnPurgeEmbargoTime": 123,
  "contentGroupId": 123,
  "cosObjectType": "ACCESS_GROUP_MEMBERSHIP",
  "created": 123,
  "createdById": 123,
  "deletedAt": 123,
  "destination": "<string>",
  "id": 123,
  "internallyCreated": true,
  "isActive": true,
  "isMatchFullUrl": true,
  "isMatchQueryString": true,
  "isOnlyAfterNotFound": true,
  "isPattern": true,
  "isProtocolAgnostic": true,
  "isRegex": true,
  "isTrailingSlashOptional": true,
  "label": "<string>",
  "lastUsedAt": 123,
  "name": "<string>",
  "note": "<string>",
  "portalId": 123,
  "precedence": 123,
  "redirectStyle": 123,
  "routePrefix": "<string>",
  "updated": 123,
  "updatedById": 123
}
'
{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

Supported products

Autorizações

Authorization
string
header
obrigatório

The access token received from the authorization server in the OAuth 2.0 flow.

Corpo

*/*
cdnPurgeEmbargoTime
integer<int64>
obrigatório

Uma data/hora Unix em milissegundos indicando o tempo de embargo para a limpeza de CDN relacionada ao mapeamento de URL.

contentGroupId
integer<int64>
obrigatório

Um número inteiro de 64 bits que representa o grupo de conteúdo associado ao mapeamento de URL.

cosObjectType
enum<string>
obrigatório

Uma string que representa o tipo de objeto de conteúdo associado ao mapeamento de URL. Os valores válidos incluem vários tipos de conteúdo, como "CONTENT", "LAYOUT", "FILE" etc.

Opções disponíveis:
ACCESS_GROUP_MEMBERSHIP,
APP_PAGE,
BLOCK,
BLOG,
BLOG_AUTHOR,
BRAND_BUSINESS_UNIT,
BRAND_SETTINGS,
CONTACT_MEMBERSHIP,
CONTENT,
CONTENT_EMBED,
CONTENT_FOLDER,
CONTENT_GROUP,
CRM_OBJECT,
CRM_OBJECT_TYPE,
CUSTOM_WIDGET,
CUSTOMER_PORTAL,
DATA_QUERY,
DESIGN_FOLDER,
DOMAIN,
DOMAIN_SETTINGS,
EMAIL_ADDRESS,
EXTENSION_RESOURCE,
FILE,
FOLDER,
FOLLOW_ME,
FORM,
GLOBAL_CONTENT,
HUBDB_TABLE,
HUBDB_TABLE_ROW,
IMAGE,
JS_PROJECT_COMPONENT,
KNOWLEDGE_BASE,
KNOWLEDGE_CATEGORY,
KNOWLEDGE_CATEGORY_TRANSLATION,
KNOWLEDGE_HOMEPAGE_CATEGORY,
LAYOUT,
LAYOUT_SECTION,
LIST_MEMBERSHIP,
MARKETPLACE_LISTING,
PASSWORD_PROTECTED,
PAYMENT,
PERSONALIZATION_TOKEN,
PLACEMENT,
PROJECT,
QUOTE_TEMPLATE,
RAW_ASSET,
REDIRECT_URL,
SECTION,
SERVERLESS_FUNCTION,
SITE_MAP,
SITE_MENU,
SITE_SETTINGS,
SUBSCRIPTIONS_SETTINGS,
TAG,
THEME,
THEME_SETTINGS,
UNRESTRICTED_ACCESS,
URL_MAPPING,
VIDEO_PLAYER,
WIDGET,
WORKFLOW
created
integer<int64>
obrigatório

A data/hora Unix em milissegundos indicando quando o mapeamento de URL foi criado.

createdById
integer<int32>
obrigatório

O identificador do usuário que criou o mapeamento de URL.

deletedAt
integer<int64>
obrigatório

A data/hora Unix em milissegundos indicando quando o mapeamento de URL foi excluído.

destination
string
obrigatório

O URL de destino para o qual o routePrefix é redirecionado.

id
integer<int64>
obrigatório

O identificador exclusivo do mapeamento de URL, representado como um número inteiro de 64 bits.

internallyCreated
boolean
obrigatório

Um booleano que indica se o mapeamento de URL foi criado internamente pelo sistema.

isActive
boolean
obrigatório

Um booleano que indica se o mapeamento de URL está ativo no momento.

isMatchFullUrl
boolean
obrigatório

Um booleano que indica se o URL completo deve ser correspondido.

isMatchQueryString
boolean
obrigatório

Um booleano que indica se a string de consulta deve ser correspondida.

isOnlyAfterNotFound
boolean
obrigatório

Um booleano que indica se o mapeamento deve ser aplicado somente após uma resposta "404 Não encontrado".

isPattern
boolean
obrigatório

Um booleano que indica se o routePrefix é um padrão.

isProtocolAgnostic
boolean
obrigatório

Um booleano que indica se o mapeamento deve ignorar o protocolo de URL (http/https).

isRegex
boolean
obrigatório

Um booleano que indica se o routePrefix deve ser tratado como uma expressão regular.

isTrailingSlashOptional
boolean
obrigatório

Um booleano que indica se a barra final no URL é opcional.

label
string
obrigatório

Um rótulo para o mapeamento de URL.

lastUsedAt
integer<int64>
obrigatório
name
string
obrigatório

O nome do mapeamento de URL.

note
string
obrigatório

Uma string que contém observações sobre o mapeamento de URL.

portalId
integer<int32>
obrigatório

O identificador do portal HubSpot associado a este mapeamento de URL.

precedence
integer<int32>
obrigatório

Um número inteiro que representa a precedência do mapeamento de URL, usado para determinar a ordem de avaliação.

redirectStyle
integer<int32>
obrigatório

Um número inteiro que representa o estilo de redirecionamento usado.

routePrefix
string
obrigatório

O prefixo do caminho da URL que está sendo mapeado.

updated
integer<int64>
obrigatório

A data/hora Unix em milissegundos indicando quando o mapeamento de URL foi atualizado pela última vez.

updatedById
integer<int32>
obrigatório

O identificador do usuário que atualizou o mapeamento de URL pela última vez.

Resposta

default - */*
category
string
obrigatório

A categoria de erro

correlationId
string<uuid>
obrigatório

Um identificador exclusivo para a solicitação. Inclua este valor em relatórios de erro ou tickets de suporte

Exemplo:

"aeb5f871-7f07-4993-9211-075dc63e7cbf"

message
string
obrigatório

Uma mensagem legível por humanos que descreve o erro, juntamente com as etapas de correção, quando apropriado

Exemplo:

"An error occurred"

context
object

Contexto sobre a condição do erro

Exemplo:

"{invalidPropertyName=[propertyValue], missingScopes=[scope1, scope2]}"

errors
object[]

mais informações sobre o erro

Um mapa de nomes de links para URIs associados que contêm documentação sobre o erro ou as etapas de correção recomendadas

subCategory
string

Uma categoria específica que contém mais detalhes específicos sobre o erro

Last modified on April 13, 2026