Pular para o conteúdo principal
POST
/
cms
/
v3
/
url-redirects
Criar um redirecionamento
curl --request POST \
  --url https://api.hubapi.com/cms/v3/url-redirects/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "destination": "<string>",
  "redirectStyle": 123,
  "routePrefix": "<string>",
  "isMatchFullUrl": true,
  "isMatchQueryString": true,
  "isOnlyAfterNotFound": true,
  "isPattern": true,
  "isProtocolAgnostic": true,
  "isTrailingSlashOptional": true,
  "precedence": 123
}
'
{
  "destination": "<string>",
  "id": "<string>",
  "isMatchFullUrl": true,
  "isMatchQueryString": true,
  "isOnlyAfterNotFound": true,
  "isPattern": true,
  "isProtocolAgnostic": true,
  "isTrailingSlashOptional": true,
  "precedence": 123,
  "redirectStyle": 123,
  "routePrefix": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z"
}

Produtos suportados

Requer um dos seguintes produtos ou superior.
Marketing HubMarketing Hub -Professional
Sales HubSales Hub -Grátis
Service HubService Hub -Grátis
Content HubContent Hub -Starter

Autorizações

​
Authorization
string
header
obrigatório

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

Corpo

application/json
​
destination
string
obrigatório

O URL de destino, onde o URL deve ser redirecionado se corresponder a routePrefix.

​
redirectStyle
integer<int32>
obrigatório

O tipo de redirecionamento a ser criado. As opções incluem: 301 (permanente), 302 (temporário) ou 305 (proxy).

​
routePrefix
string
obrigatório

O URL de entrada, caminho ou padrão de destino a ser correspondido para redirecionar.

​
isMatchFullUrl
boolean

Se routePrefix deve corresponder a todo o URL, incluindo o domínio.

​
isMatchQueryString
boolean

Se routePrefix deve corresponder ao caminho completo do URL, incluindo a string de consulta.

​
isOnlyAfterNotFound
boolean

Se o mapeamento do redirecionamento de URL deve ser aplicado apenas se uma página ativa no URL não for encontrada. Se falso, o mapeamento do redirecionamento de URL terá precedência sobre qualquer página existente.

​
isPattern
boolean

Se routePrefix deve corresponder com base no padrão.

​
isProtocolAgnostic
boolean

Se routePrefix deve corresponder aos protocolos HTTP e HTTPS.

​
isTrailingSlashOptional
boolean

Se uma barra final será ignorada.

​
precedence
integer<int32>

Usado para priorizar o redirecionamento de URL. Se um URL fornecido corresponder a mais de um redirecionamento, o redirecionamento com menor precedência será usado.

Resposta

successful operation

​
destination
string
obrigatório

O URL de destino, onde o URL deve ser redirecionado se corresponder a "routePrefix".

​
id
string
obrigatório

O ID exclusivo deste redirecionamento de URL.

​
isMatchFullUrl
boolean
obrigatório

Se "routePrefix" deve corresponder a todo o URL, incluindo o domínio.

​
isMatchQueryString
boolean
obrigatório

Se "routePrefix" deve corresponder ao caminho completo do URL, incluindo a string de consulta.

​
isOnlyAfterNotFound
boolean
obrigatório

Se o mapeamento do redirecionamento de URL deve ser aplicado apenas se uma página ativa no URL não for encontrada. Se falso, o mapeamento do redirecionamento de URL terá precedência sobre qualquer página existente.

​
isPattern
boolean
obrigatório

Se "routePrefix" deve corresponder com base no padrão.

​
isProtocolAgnostic
boolean
obrigatório

Se "routePrefix" deve corresponder aos protocolos HTTP e HTTPS.

​
isTrailingSlashOptional
boolean
obrigatório

Se uma barra final será ignorada.

​
precedence
integer<int32>
obrigatório

Usado para priorizar o redirecionamento de URL. Se um URL fornecido corresponder a mais de um redirecionamento, o redirecionamento com menor precedência será usado.

​
redirectStyle
integer<int32>
obrigatório

O tipo de redirecionamento a ser criado. As opções incluem: 301 (permanente), 302 (temporário) ou 305 (proxy). Encontre mais detalhes aqui.

​
routePrefix
string
obrigatório

O URL de entrada, caminho ou padrão de destino a ser correspondido para redirecionar.

​
created
string<date-time>

A data e a hora da criação inicial do mapamento de URL.

​
updated
string<date-time>

A data e a hora da última modificação do mapeamento de URL.

Last modified on December 8, 2025