Editar um Template

Atualiza um Template existente pelo seu ID ou nome.

PUThttps://api2.transloadit.com/templates/{templateIdOrName}

Atualiza o Template representado por TEMPLATE_ID_OR_NAME. As configurações de nível superior omitidas normalmente permanecem inalteradas, portanto o exemplo de requisição abaixo renomeia o Template sem alterar suas Instructions.

Fornecer template substitui integralmente as Instructions armazenadas; não mescla nem altera parcialmente Steps individuais. Inclua nesse objeto todos os Steps e Instructions que você quiser manter.

O agendamento cron é um recurso em prévia com acesso controlado. Cada Workspace participante pode habilitar um Template, com no máximo 10.000 ticks admitidos por dia UTC. Forneça cron_region, um cron_schedule_with_seconds de seis campos e cron_auth_key_id antes de definir cron_enabled como true. A Auth Key selecionada deve pertencer a este Workspace e permitir a criação de Assemblies. Quem faz a chamada também deve ter permissão para criar Assemblies ao habilitar ou editar um agendamento ativo. Desabilitar o agendamento não exige permissão para criar Assemblies. Se o agendamento ficar indisponível ou o Workspace perder o acesso à prévia, uma edição comum do Template desabilitará automaticamente o agendamento, preservando sua região, programação, ID da Auth Key e execução existente. Desabilitar um Template ou pausar seu Workspace, sua região ou o agendador impede novas admissões. Um tick já admitido de forma durável ainda pode ser concluído.

Os agendamentos são executados em UTC e devem manter um intervalo de pelo menos 10 segundos entre cada par de ticks consecutivos. As Instructions devem usar importações HTTP ou S3 autossuficientes e não podem depender de arquivos enviados por meio de :original ou /upload/handle. As Assemblies agendadas importam no máximo 1.000 arquivos de entrada e respeitam um limite menor definido em max_number_of_files. Alterações na execução entram em vigor no próximo tick futuro. Ticks perdidos são ignorados. O padrão de cron_max_concurrent_runs é 1; aumente esse valor até 10 para permitir execuções agendadas simultâneas. Inícios pendentes e execuções não resolvidas contam para o limite mesmo após edições do Template e ciclos de desabilitação e reabilitação. Ao atingir o limite, os ticks são ignorados com resultado e motivo overlap; eles não são enfileirados para depois. Reduzir o limite não cancela execuções existentes. Assemblies manuais não contam para esse limite, e os limites comuns do Workspace continuam se aplicando. Essa configuração não elimina duplicatas dos arquivos importados. Um início consumido sem um checkpoint de Assembly mantém sua vaga até atingir seu tempo limite configurável, cujo padrão é 10 minutos. Em seguida, ele é marcado como lost com o motivo start_checkpoint_missing, permitindo que ticks posteriores prossigam. Esse tick nunca é repetido. Uma Assembly que permanece em estado de falha sem um checkpoint de recuperação pelo mesmo tempo limite passa a ser lost com o motivo recovery_checkpoint_missing, também permitindo que ticks futuros prossigam. Assemblies abortadas ou com falha mantêm a sobreposição até que seus Jobs terminem. Se um checkpoint final nunca chegar, elas expiram após o tempo máximo de vida de uma Assembly do Workspace mais o período de tolerância para checkpoints; em seguida, usam o mesmo tempo limite de perda, de duração limitada, sem reiniciar o processamento abortado ou com falha. Um checkpoint de Assembly que chega atrasado corrige o resultado mantido com o motivo start_checkpoint_late. Execuções perdidas liberam suas vagas permanentemente. Por isso, uma Assembly atrasada pode exceder temporariamente o limite configurado, inclusive o padrão de 1; isso não é um mutex estrito de execução.

Exemplo de requisição

Defina TEMPLATE_ID_OR_NAME com o valor do seu recurso, sem aplicar codificação percentual a ele.

Execute esta requisição em um shell no servidor com curl e um token bearer adequado em TRANSLOADIT_TOKEN. Se precisar de um token, expanda a configuração abaixo.

Precisa de um token bearer?

Em um shell confiável no servidor com curl e jq, defina TRANSLOADIT_KEY e TRANSLOADIT_SECRET com sua Auth Key e seu Auth Secret. Mantenha ambas as credenciais e o token resultante em segredo; nunca execute essa configuração em código de navegador.

Primeiro, crie um token com os escopos exigidos por este endpoint. Sua Auth Key já deve conceder esses escopos.

if ! TOKEN_RESPONSE="$(curl --fail-with-body -sS \
  --request POST \
  --url 'https://api2.transloadit.com/token' \
  --user "${TRANSLOADIT_KEY:?Set TRANSLOADIT_KEY}:${TRANSLOADIT_SECRET:?Set TRANSLOADIT_SECRET}" \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'grant_type=client_credentials' \
  --data-urlencode 'aud=api2' \
  --data-urlencode 'scope=templates:write')"; then
  printf '%s\n' "$TOKEN_RESPONSE" >&2
  exit 1
fi
TRANSLOADIT_TOKEN="$(printf '%s' "$TOKEN_RESPONSE" |
  jq -er '.access_token | strings | select(length > 0)')" || exit 1

Mantenha este shell aberto e execute a requisição abaixo. Reutilize o token enquanto ele permanecer válido.

curl --fail-with-body -sS --request PUT \
  --url "https://api2.transloadit.com/templates/${TEMPLATE_ID_OR_NAME:?Set TEMPLATE_ID_OR_NAME}" \
  --header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
  --data-urlencode 'params={"name":"resized-images"}'

Autenticação

Este endpoint aceita params assinados ou um token bearer. Consulte Autenticação para instruções de configuração.

Escopo necessário para a Auth Key ou o token bearer: templates:write.

Requisições assinadas exigem tanto uma signature quanto um timestamp params.auth.expires no futuro. Tokens Bearer não exigem nenhum dos dois.

Parâmetros de caminho

templateIdOrName (segmento de caminho), obrigatório. padrão: ^[a-z0-9-]+$, comprimento mínimo: 1

Campos do formulário

Tipo de conteúdo: application/x-www-form-urlencoded

params (string JSON), obrigatório. Um objeto codificado em JSON cujas chaves suportadas estão listadas abaixo.
signature (string). Obrigatório para requisições assinadas. Omita este campo ao usar um bearer token.

Chaves compatíveis dentro do campo `params`

Os campos de autenticação desta lista se aplicam a requisições assinadas. Com um bearer token, você pode omitir params.auth e o campo signature separado. Compare os parâmetros de requisição específicos de autenticação abaixo.

Esquema JSON completo

Abrir JSON em uma nova aba

params: Somente os campos listados para este objeto são aceitos.

Campo Tipo e descrição

params.assembly_status_expiry

"1day" | "30days" | "7days" | "90days" | "NoSave"

Controla por quanto tempo o Assembly Status é retido para Assemblies criadas a partir deste Template.

params.auth

obrigatório para requisições assinadas; opcional com um bearer token

object

Contém a chave de API da Transloadit e os metadados de autenticação por assinatura para uma requisição de Template.

params.auth: Somente os campos listados para este objeto são aceitos.

params.auth.expires

obrigatório

string

Timestamp de expiração no formato ISO 8601 situado no futuro. Obrigatório quando uma requisição é assinada ou exige autenticação por assinatura; requisições autenticadas por bearer podem omiti-lo.

params.auth.key

obrigatório

string

Chave de API da Transloadit usada para autenticar as requisições

params.cron_auth_key_id

string | null

ID de uma Auth Key ativa e não expirada pertencente a este Workspace, com permissão para criar Assemblies. Obrigatório ao habilitar a pré-visualização do Template Cron. A chave deve permitir a assinatura e não pode ser uma chave interna.

Padrão de validação (expressão regular)

^[a-f0-9]{32}$

params.cron_enabled

boolean

Ativa ou desativa a prévia do Template Cron. Ativar ou editar um agendamento ativo exige que o chamador tenha permissão para criar Assemblies. A omissão mantém a configuração atual enquanto o agendamento permanecer disponível; uma edição comum desativa automaticamente o agendamento se o acesso à prévia for revogado. Cada Workspace elegível pode ativar um Template Cron. As Instructions devem ser autossuficientes, usando importações HTTP ou S3 sem :original ou /upload/handle. Disparos perdidos são ignorados, e um disparo é ignorado quando o Template atinge seu limite de execuções simultâneas.

params.cron_max_concurrent_runs

integer (mínimo: 1, máximo: 10)

Número máximo de execuções agendadas simultâneas deste Template. O padrão é 1 na criação; omitir este valor na atualização preserva o limite salvo. Disparos do agendamento que ocorrem com o limite atingido são ignorados, não enfileirados. Inícios pendentes e execuções não resolvidas contam até a conclusão ou até o tempo limite de perda de checkpoint. Execuções perdidas liberam sua vaga permanentemente, então uma Assembly atrasada pode exceder temporariamente este limite. Não elimina duplicatas de arquivos importados nem limita Assemblies manuais. Os limites normais do Workspace continuam valendo.

params.cron_region

"ap-southeast-1" | "eu-west-1" | "us-east-1" | null

API regional usada para Assemblies agendadas. Obrigatória ao habilitar a prévia do Cron Template.

params.cron_schedule_with_seconds

string | null (comprimento mínimo: 1, comprimento máximo: 255)

Expressão cron numérica de seis campos, avaliada em UTC: segundo, minuto, hora, dia do mês, mês e dia da semana. Suporta curingas, valores separados por vírgulas, intervalos e incrementos. Os disparos agendados devem ter um intervalo mínimo de 10 segundos entre si. O agendamento de Templates por cron está em prévia com acesso controlado.

params.name

string (comprimento mínimo: 3, comprimento máximo: 200)

Nome deste Template. Use de 3 a 200 letras latinas minúsculas, números ou hifens. O nome tmp e os nomes reservados pelo serviço não estão disponíveis.

Padrão de validação (expressão regular)

^(?:[a-su-z0-9-][a-z0-9-]{2,199}|t[a-ln-z0-9-][a-z0-9-]{1,198}|tm[a-oq-z0-9-][a-z0-9-]{0,197}|tmp[a-z0-9-]{1,197})$

params.nonce

string | integer

Valor único e aleatório incluído nos parâmetros da requisição assinada para tornar cada assinatura única e evitar a reutilização acidental de assinaturas.

params.require_signature_auth

0 | 1

Use 1 para exigir uma assinatura válida ao criar Assemblies a partir deste Template com uma Auth Key. Tokens bearer válidos ignoram essa exigência de assinatura; seus escopos e sua audiência continuam se aplicando. Essa configuração não adiciona autenticação às URLs de status da Assembly, de cancelamento ou de capacidade de upload. Consulte Signature Authentication.

params.template

object | string

Assembly Instructions armazenadas neste Template. Prefira o objeto JSON estruturado; uma string codificada em JSON continua sendo aceita por compatibilidade.

Qualquer um dos esquemas a seguir pode ser aplicado:

object

object

Assembly Instructions estruturadas armazenadas neste Template.

params.template: Somente os campos listados para este objeto são aceitos.

Campo	Tipo e descrição
`params.template.allow_steps_override`	`boolean` Defina isto como false em um Template armazenado para não permitir a substituição de seus Steps em tempo de execução. O Template pode então ser usado com `template_id`, ou `steps` diretos podem ser fornecidos sem ele, mas não ambos. Um valor fornecido apenas durante a criação de uma Assembly não controla essa política.
`params.template.auth`	`object` Autenticação opcional e restrições de upload para uma Assembly. A chave de API pode ser omitida em requisições autenticadas por bearer ou quando apenas restrições de upload estão armazenadas em um Template. Detalhes adicionais do esquema estão disponíveis no JSON Schema completo.
`params.template.emit_execution_progress`	`boolean` Defina como true para publicar eventos de Assembly Execution Progress em tempo real. Isso é ignorado para Assemblies de URL Transform.
`params.template.exiftool_stack`	`string` Ignorado quando armazenado em um Template. Para selecionar o stack do ExifTool para extração de metadados, defina `exiftool_stack` nos params de nível superior da requisição da Assembly.
`params.template.ffmpeg_stack`	`string` Ignorado quando armazenado em um Template. Para selecionar o stack do FFmpeg para extração de metadados, defina `ffmpeg_stack` nos parâmetros de nível superior da requisição da Assembly.
`params.template.fields`	`object` Um objeto de valores com chaves em string (nome -> valor) que podem ser usados como Assembly Variables, assim como campos de formulário adicionais também podem. Você pode usar como valor qualquer coisa que seja convertível para string JSON Detalhes adicionais do esquema estão disponíveis no JSON Schema completo.
`params.template.imagemagick_stack`	`string` Ignorado quando armazenado em um Template. Para selecionar o stack do ImageMagick para extração de metadados, defina `imagemagick_stack` nos parâmetros de nível superior da requisição da Assembly.
`params.template.mediainfo_stack`	`string` Ignorado quando armazenado em um Template. Para selecionar o stack do MediaInfo para extração de metadados, defina `mediainfo_stack` nos parâmetros de nível superior da requisição da Assembly.
`params.template.mplayer_stack`	`string` Ignorado quando armazenado em um Template. Para selecionar o stack MPlayer para a extração de metadados, defina `mplayer_stack` nos parâmetros de nível superior da requisição da Assembly.
`params.template.notification_payload`	`Array<"without_params" \| "without_result_meta_data" \| "without_results" \| "without_upload_meta_data" \| "without_uploads">` Controla o tamanho do payload enviado nas Assembly Notifications. Os replays de Notification reutilizam os filtros informados na requisição original da Assembly; filtros definidos apenas em um Template não são preservados no replay. Um array vazio (padrão) envia o Assembly Status completo. Adicione `"without_params"` para que os campos brutos de Assembly Instructions de nível superior `params`, `template` e `merged_params` sejam omitidos. Adicione `"without_result_meta_data"` para que `meta` seja omitido de cada arquivo em `results`. Adicione `"without_results"` para que o objeto `results` de nível superior seja omitido. Adicione `"without_upload_meta_data"` para que `meta` seja omitido de cada arquivo em `uploads`. Adicione `"without_uploads"` para que o array `uploads` de nível superior seja omitido. A filtragem é aplicada antes da serialização, portanto usar essas opções reduz o uso de memória e ajuda a evitar falhas por payload grande demais ou por OOM em Assemblies grandes.
`params.template.notify_url`	`null \| string` A Transloadit pode enviar um Pingback para o seu servidor quando a Assembly for concluída. Enviaremos o Assembly Status como uma string JSON no campo `transloadit` de uma requisição POST `application/x-www-form-urlencoded` para a URL informada aqui. Use `notification_payload` para reduzir o tamanho do payload (por exemplo, `without_uploads`, `without_results`, `without_params`). Os replays de Notification reutilizam apenas os filtros informados na requisição original da Assembly, não os filtros definidos somente em um Template.
`params.template.quiet`	`boolean` Defina isto como true para minimizar a resposta inicial de criação da Assembly. Uma resposta bem-sucedida inclui apenas ok e assembly_id; uma resposta de erro mantém error, http_code, message, reason e assembly_id quando disponível. Isso é minimização de resposta, não controle de acesso: qualquer pessoa que tenha o Assembly ID retornado ainda consegue obter o Assembly Status completo, incluindo campos e resultados, sem autenticação adicional. Trate Assembly IDs e URLs de status como capacidades secretas. O Assembly Status completo continua sendo enviado para notify_url quando configurado.
`params.template.redirect_url`	`string` URL para a qual um upload de navegador é redirecionado após a conclusão do upload. O Assembly ID e a URL de status são anexados como parâmetros de consulta, preservando os parâmetros de consulta e o fragmento já existentes.
`params.template.response_headers`	`object` Cabeçalhos de resposta personalizados emitidos por uma Assembly. Defina os cabeçalhos CORS em `response_headers.cors`, por exemplo `response_headers: { "cors": { "Access-Control-Allow-Origin": "https://example.com", "Access-Control-Allow-Methods": "GET, POST, OPTIONS" } }`. As demais chaves de nível superior em `response_headers` são emitidas como cabeçalhos personalizados. Detalhes adicionais do esquema estão disponíveis no JSON Schema completo.
`params.template.steps`	`esquema referenciado` Contém as Assembly Instructions. Detalhes adicionais do esquema estão disponíveis no JSON Schema completo.
`params.template.template_id`	`string` Ignorado quando armazenado em um Template. Templates não herdam Instructions de outro Template. Coloque os Steps diretamente neste Template e selecione-o usando `template_id` nos parâmetros de requisição da Assembly de nível superior.
`params.template.usage_tags`	`string` Tags de uso registradas em uma Assembly.

string

string

Assembly Instructions codificadas em JSON, mantidas para compatibilidade com clientes.

Padrão de validação (expressão regular)

^[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*\{(?:[^\x00]|\x00)*\}[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*$

params.transcoding_result_expiry

"1day" | "NoSave"

Controla por quanto tempo os resultados de transcodificação são mantidos para Assemblies criadas a partir deste Template.

Parâmetros de requisição por método de autenticação

Com parâmetros assinados

Inclua sua Auth Key como params.auth.key. Ao assinar a requisição, inclua um timestamp futuro em params.auth.expires e envie a assinatura no campo separado signature. As definições de campos abaixo usam caminhos dentro de params.

Esquema JSON completo

Abrir JSON em uma nova aba

params: Somente os campos listados para este objeto são aceitos.

Usa as definições de campo acima: params.assembly_status_expiry, params.auth, params.cron_auth_key_id, params.cron_enabled, params.cron_max_concurrent_runs, params.cron_region, params.cron_schedule_with_seconds, params.name, params.nonce, params.require_signature_auth, params.template, params.transcoding_result_expiry

Com um token bearer

Envie o token bearer no cabeçalho Authorization. Você pode omitir params.auth e o campo signature separado. Os demais parâmetros obrigatórios continuam se aplicando. As definições de campos abaixo usam caminhos dentro de params.

Esquema JSON completo

Abrir JSON em uma nova aba

params: Somente os campos listados para este objeto são aceitos.

Usa as definições de campo acima: params.assembly_status_expiry, params.cron_auth_key_id, params.cron_enabled, params.cron_max_concurrent_runs, params.cron_region, params.cron_schedule_with_seconds, params.name, params.nonce, params.require_signature_auth, params.template, params.transcoding_result_expiry

Campo	Tipo e descrição
`params.auth`	`object` Contém a chave de API da Transloadit e os metadados de autenticação por assinatura para uma requisição de Template. `params.auth`: Somente os campos listados para este objeto são aceitos.
`params.auth.expires`	`string` Timestamp de expiração no formato ISO 8601 situado no futuro. Obrigatório quando uma requisição é assinada ou exige autenticação por assinatura; requisições autenticadas por bearer podem omiti-lo.
`params.auth.key`	`string` Chave de API da Transloadit usada para autenticar as requisições

Resposta

Veja um exemplo de corpo de resposta:

{
  "assembly_status_expiry": null,
  "content": {
    "steps": {
      "resize": {
        "robot": "/image/resize",
        "use": ":original",
        "width": 320
      }
    }
  },
  "id": "8fc3b9166c784afd824acf24269ebd11",
  "message": "Your Template was successfully updated.",
  "name": "resized-images",
  "ok": "TEMPLATE_UPDATED",
  "require_signature_auth": 0,
  "transcoding_result_expiry": null
}

sucesso 2xx

Corpo da resposta JSON. application/json text/plain; charset=utf-8

Esquema do corpo da resposta

Esquema JSON completo

Abrir JSON em uma nova aba

A resposta contém apenas os campos listados para este objeto.

Campo	Tipo e descrição
`assembly_status_expiry` obrigatório	`null \| string`
`content` obrigatório	`object \| Array<qualquer valor> \| string \| number \| boolean \| null` Qualquer um dos esquemas a seguir pode ser aplicado: object `object` Esquema de propriedade adicional `qualquer valor` Array<qualquer valor> `Array<qualquer valor>` Esquema do item do array `qualquer valor` `string` `number` `boolean` `null`
`cron_auth_key_id`	`string \| null` Padrão de validação (expressão regular) `^[a-f0-9]{32}$`
`cron_enabled`	`boolean`
`cron_max_concurrent_runs`	`integer` (mínimo: 1, máximo: 10)
`cron_region`	`"ap-southeast-1" \| "eu-west-1" \| "us-east-1" \| null`
`cron_schedule_with_seconds`	`string \| null` (comprimento mínimo: 1, comprimento máximo: 255)
`id` obrigatório	`string` Qualquer um dos esquemas a seguir pode ser aplicado: Variante 1: string (comprimento máximo: 32) `string` Padrão de validação (expressão regular) `^[\x00-\x7F]*$` Variante 2: string (comprimento máximo: 32) `string` Padrão de validação (expressão regular) `^builtin\/[a-z0-9-]+(?:@[0-9a-z.-]+)?$`
`message` obrigatório	`string` (comprimento mínimo: 1)
`name` obrigatório	`string` (comprimento mínimo: 1, comprimento máximo: 255)
`ok` obrigatório	`string` (sempre: "TEMPLATE_UPDATED")
`require_signature_auth` obrigatório	`0 \| 1`
`transcoding_result_expiry` obrigatório	`null \| string`

Resposta de erro

Corpo da resposta JSON. application/json text/plain; charset=utf-8

Esquema do corpo da resposta

Esquema JSON completo

Abrir JSON em uma nova aba

Pelo menos uma destas propriedades é obrigatória: error, message, reason

A resposta pode conter campos adicionais.

Campo	Tipo e descrição
`assembly_id`	`string`
`error`	`string` (comprimento mínimo: 1)
`http_code`	`number \| string` `number` `string` Padrão de validação (expressão regular) ^[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff][+-]?0(?:0(?:[^0-9]\|$)\|(?:[1-9][0-9]{0,307}\|1(?:(?:[0-6][0-9]{7}\|7[0-8][0-9]{6}\|79[0-6][0-9]{5}\|797[0-5][0-9]{4}\|7976[0-8][0-9]{3}\|79769[0-2][0-9]{2}\|7976930[0-9]{1}\|7976931[0-2])[0-9]{300}\|79769313(?:(?:[0-3][0-9]{7}\|4[0-7][0-9]{6}\|48[0-5][0-9]{5}\|486[0-1][0-9]{4}\|4862[0-2][0-9]{3}\|486230[0-9]{2}\|486231[0-4][0-9]{1}\|4862315[0-7])[0-9]{292}\|48623158(?:(?:0[0-6][0-9]{6}\|07[0-8][0-9]{5}\|079[0-2][0-9]{4}\|0793[0-6][0-9]{3}\|07937[0-1][0-9]{2}\|079372[0-7][0-9]{1}\|0793728[0-8])[0-9]{284}\|07937289(?:(?:[0-6][0-9]{7}\|70[0-9]{6}\|71[0-3][0-9]{5}\|7140[0-4][0-9]{3}\|71405[0-2][0-9]{2}\|7140530[0-2])[0-9]{276}\|71405303(?:(?:[0-3][0-9]{7}\|40[0-9]{6}\|41[0-4][0-9]{5}\|4150[0-6][0-9]{3}\|41507[0-8][0-9]{2}\|415079[0-8][0-9]{1}\|4150799[0-2])[0-9]{268}\|41507993(?:(?:[0-3][0-9]{7}\|40[0-9]{6}\|41[0-2][0-9]{5}\|413[0-1][0-9]{4}\|4132[0-6][0-9]{3}\|413270[0-9]{2})[0-9]{260}\|41327100(?:(?:[0-2][0-9]{7}\|3[0-6][0-9]{6}\|37[0-7][0-9]{5}\|378[0-1][0-9]{4}\|3782[0-5][0-9]{3}\|37826[0-8][0-9]{2}\|378269[0-2][0-9]{1}\|3782693[0-5])[0-9]{252}\|37826936(?:(?:0[0-9]{7}\|1[0-6][0-9]{6}\|17[0-2][0-9]{5}\|173[0-6][0-9]{4}\|1737[0-6][0-9]{3}\|17377[0-7][0-9]{2}\|173778[0-8][0-9]{1}\|1737789[0-7])[0-9]{244}\|17377898(?:(?:0[0-3][0-9]{6}\|04[0-3][0-9]{5}\|044[0-3][0-9]{4}\|0444[0-8][0-9]{3}\|04449[0-5][0-9]{2}\|044496[0-7][0-9]{1}\|0444968[0-1])[0-9]{236}\|04449682(?:(?:[0-8][0-9]{7}\|9[0-1][0-9]{6}\|92[0-6][0-9]{5}\|927[0-5][0-9]{4}\|9276[0-3][0-9]{3}\|92764[0-6][0-9]{2}\|927647[0-4][0-9]{1})[0-9]{228}\|92764750(?:(?:[0-8][0-9]{7}\|9[0-3][0-9]{6}\|94[0-5][0-9]{5}\|946[0-5][0-9]{4}\|9466[0-3][0-9]{3}\|94664[0-8][0-9]{2}\|94664900)[0-9]{220}\|94664901(?:(?:[0-6][0-9]{7}\|7[0-8][0-9]{6}\|79[0-6][0-9]{5}\|797[0-6][0-9]{4}\|7977[0-4][0-9]{3}\|79775[0-7][0-9]{2}\|797758[0-6][0-9]{1}\|7977587[0-1])[0-9]{212}\|79775872(?:(?:0[0-6][0-9]{6}\|070[0-8][0-9]{4}\|0709[0-5][0-9]{3}\|07096[0-2][0-9]{2}\|070963[0-2][0-9]{1})[0-9]{204}\|07096330(?:(?:[0-1][0-9]{7}\|2[0-7][0-9]{6}\|28[0-5][0-9]{5}\|286[0-3][0-9]{4}\|28640[0-9]{3}\|28641[0-5][0-9]{2}\|286416[0-5][0-9]{1}\|2864166[0-8])[0-9]{196}\|28641669(?:(?:[0-1][0-9]{7}\|2[0-7][0-9]{6}\|28[0-7][0-9]{5}\|288[0-6][0-9]{4}\|2887[0-8][0-9]{3}\|288790[0-9]{2}\|2887910[0-8])[0-9]{188}\|28879109(?:(?:[0-3][0-9]{7}\|4[0-5][0-9]{6}\|46[0-4][0-9]{5}\|465[0-4][0-9]{4}\|4655[0-4][0-9]{3}\|46555[0-4][0-9]{2}\|465555[0-3][0-9]{1}\|4655554[0-6])[0-9]{180}\|46555547(?:(?:[0-7][0-9]{7}\|8[0-4][0-9]{6}\|850[0-9]{5}\|851[0-8][0-9]{4}\|8519[0-3][0-9]{3}\|851940[0-3][0-9]{1})[0-9]{172}\|85194040(?:(?:[0-1][0-9]{7}\|2[0-5][0-9]{6}\|26[0-2][0-9]{5}\|2630[0-5][0-9]{3}\|26306[0-4][0-9]{2}\|263065[0-6][0-9]{1}\|2630657[0-3])[0-9]{164}\|26306574(?:(?:[0-7][0-9]{7}\|8[0-7][0-9]{6}\|88[0-5][0-9]{5}\|886[0-6][0-9]{4}\|88670[0-9]{3}\|88671[0-4][0-9]{2}\|8867150[0-4])[0-9]{156}\|88671505(?:(?:[0-7][0-9]{7}\|8[0-1][0-9]{6}\|820[0-5][0-9]{4}\|8206[0-7][0-9]{3}\|820680[0-9]{2}\|820681[0-8][0-9]{1})[0-9]{148}\|82068190(?:(?:[0-7][0-9]{7}\|8[0-8][0-9]{6}\|890[0-1][0-9]{4}\|8902000[0-6])[0-9]{140}\|89020007(?:(?:0[0-7][0-9]{6}\|08[0-2][0-9]{5}\|083[0-7][0-9]{4}\|0838[0-2][0-9]{3}\|08383[0-5][0-9]{2}\|083836[0-6][0-9]{1}\|0838367[0-5])[0-9]{132}\|08383676(?:(?:[0-1][0-9]{7}\|2[0-6][0-9]{6}\|27[0-2][0-9]{5}\|273[0-7][0-9]{4}\|2738[0-4][0-9]{3}\|27385[0-3][0-9]{2}\|273854[0-7][0-9]{1}\|2738548[0-3])[0-9]{124}\|27385484(?:(?:[0-4][0-9]{7}\|5[0-7][0-9]{6}\|580[0-9]{5}\|581[0-6][0-9]{4}\|5817[0-6][0-9]{3}\|581770[0-9]{2}\|5817710[0-9]{1}\|5817711[0-4])[0-9]{116}\|58177115(?:(?:[0-2][0-9]{7}\|30[0-9]{6}\|31[0-6][0-9]{5}\|317[0-5][0-9]{4}\|3176[0-3][0-9]{3}\|31764[0-3][0-9]{2}\|317644[0-6][0-9]{1}\|3176447[0-4])[0-9]{108}\|31764475(?:(?:[0-6][0-9]{7}\|7[0-2][0-9]{6}\|730[0-1][0-9]{4}\|7302[0-6][0-9]{3}\|7302700[0-5])[0-9]{100}\|73027006(?:(?:[0-8][0-9]{7}\|9[0-7][0-9]{6}\|98[0-4][0-9]{5}\|985[0-4][0-9]{4}\|9855[0-4][0-9]{3}\|98555[0-6][0-9]{2}\|9855570[0-9]{1}\|9855571[0-2])[0-9]{92}\|98555713(?:(?:[0-5][0-9]{7}\|6[0-5][0-9]{6}\|66[0-8][0-9]{5}\|669[0-4][0-9]{4}\|6695[0-8][0-9]{3}\|66959[0-5][0-9]{2}\|669596[0-1][0-9]{1}\|6695962[0-1])[0-9]{84}\|66959622(?:(?:[0-7][0-9]{7}\|8[0-3][0-9]{6}\|84[0-1][0-9]{5}\|842[0-8][0-9]{4}\|84290[0-9]{3}\|84291[0-3][0-9]{2}\|842914[0-7][0-9]{1}\|84291480)[0-9]{76}\|84291481(?:(?:[0-8][0-9]{7}\|9[0-7][0-9]{6}\|98[0-5][0-9]{5}\|9860[0-7][0-9]{3}\|98608[0-2][0-9]{2}\|986083[0-3][0-9]{1}\|9860834[0-8])[0-9]{68}\|98608349(?:(?:[0-2][0-9]{7}\|3[0-5][0-9]{6}\|36[0-3][0-9]{5}\|364[0-6][0-9]{4}\|3647[0-4][0-9]{3}\|36475[0-1][0-9]{2}\|364752[0-8][0-9]{1}\|3647529[0-1])[0-9]{60}\|36475292(?:(?:[0-6][0-9]{7}\|70[0-9]{6}\|71[0-8][0-9]{5}\|7190[0-6][0-9]{3}\|71907[0-3][0-9]{2}\|7190740[0-9]{1}\|7190741[0-5])[0-9]{52}\|71907416(?:(?:[0-7][0-9]{7}\|8[0-3][0-9]{6}\|84[0-3][0-9]{5}\|844[0-3][0-9]{4}\|8444[0-2][0-9]{3}\|84443[0-5][0-9]{2}\|844436[0-4][0-9]{1}\|8444365[0-4])[0-9]{44}\|84443655(?:(?:0[0-9]{7}\|10[0-6][0-9]{5}\|1070[0-3][0-9]{3}\|10704[0-2][0-9]{2}\|107043[0-3][0-9]{1}\|1070434[0-1])[0-9]{36}\|10704342(?:(?:[0-6][0-9]{7}\|70[0-9]{6}\|710[0-9]{5}\|711[0-4][0-9]{4}\|7115[0-4][0-9]{3}\|71155[0-8][0-9]{2}\|711559[0-5][0-9]{1}\|7115596[0-8])[0-9]{28}\|71155969(?:(?:[0-8][0-9]{7}\|9[0-4][0-9]{6}\|950[0-7][0-9]{4}\|95080[0-8][0-9]{2}\|950809[0-2][0-9]{1})[0-9]{20}\|95080930(?:(?:[0-3][0-9]{7}\|4[0-1][0-9]{6}\|42[0-7][0-9]{5}\|428[0-7][0-9]{4}\|428800[0-9]{2}\|428801[0-6][0-9]{1}\|4288017[0-6])[0-9]{12}\|42880177(?:(?:[0-8][0-9]{7}\|90[0-3][0-9]{5}\|9040[0-9]{4}\|9041[0-6][0-9]{3}\|90417[0-3][0-9]{2}\|904174[0-3][0-9]{1}\|9041744[0-8])[0-9]{4}\|90417449(?:(?:[0-6][0-9]{3}\|7[0-6][0-9]{2}\|77[0-8][0-9]{1}\|7790)\|7791))))))))))))))))))))))))))))))))))))))))(?:[^0-9]\|$))
`message`	`string` Explicação do erro legível por humanos. A redação pode variar; use o código `error` ao tratar uma falha específica.
`reason`	`null \| string \| number \| boolean \| Array<qualquer valor> \| object` Qualquer um dos esquemas a seguir pode ser aplicado: `null` `string` `number` `boolean` Array<qualquer valor> `Array<qualquer valor>` Esquema do item do array `qualquer valor` object `object` Esquema de propriedade adicional `qualquer valor`

HTTP 400

Corpo da resposta JSON. application/json text/plain; charset=utf-8

Esquema do corpo da resposta

Esquema JSON completo

Abrir JSON em uma nova aba

Erros nomeados e o formato geral de erro

error: "TEMPLATE_VALIDATION_ERROR"

Seu Template não passou na validação.

A resposta pode conter campos adicionais.

Campo	Tipo e descrição
`error` obrigatório	`string` (sempre: "TEMPLATE_VALIDATION_ERROR")
`http_code`	`number` (sempre: 400)
`message`	`string` Explicação do erro legível por humanos. A redação pode variar; use o código `error` ao tratar uma falha específica.

Formato geral de erro

Consulte os campos gerais de resposta de erro.

Editar um Template

Exemplo de requisição

Autenticação

Parâmetros de caminho

Campos do formulário

Chaves compatíveis dentro do campo params

Parâmetros de requisição por método de autenticação

Resposta

sucesso 2xx

Resposta de erro

HTTP 400

Chaves compatíveis dentro do campo `params`