Skip to main content

​
Atributos dos Templates

Esta página descreve os valores que aparecem nos campos status, quality_score, category, language, display_format e sub_category do objeto de template, além dos demais campos retornados pela API.

​
Objeto de template

As rotas de listagem, exibição e criação retornam o template neste formato:

​
Status

Define o status do template. O campo status retorna id, code e description.
Os ids 10 e 11 têm o mesmo code (PAUSED) e a mesma descrição. Eles representam a primeira e a segunda pausa do template, e a única forma de distingui-los na API e nos webhooks é pelo status.id.
Para filtrar a listagem por status, use o id numérico (por exemplo, status=2). Veja Listar templates.

​
Quality score

Define a qualidade do template. O campo quality_score retorna id e code.

​
Categorias

Define a categoria do template. O campo category retorna id, code e description. A coluna Criação pela API indica se a categoria é aceita no endpoint de criação. As categorias marcadas como descontinuadas continuam existindo na tabela, mas a criação com elas é rejeitada com 422.
Na criação, envie o code da categoria (MARKETING, UTILITY ou AUTHENTICATION) no campo category.

​
Display format

Define se um template é do tipo “detalhes do pedido”. Aparece no objeto somente quando definido.

​
Sub category

Define se um template é do tipo “status do pedido”. Aparece no objeto somente quando definido.
A rota GET /restrictions informa se o workspace possui a permissão order_details, relacionada ao uso de display_format e sub_category.

​
Idiomas

Define o idioma do template. No campo language da criação, envie o code do idioma. O objeto retornado traz id, code e name.
O id 0 (?, indefinido) existe na tabela, mas não deve ser usado na criação de templates.

​
Saiba mais