Skip to main content
GET
Consultar template

Authorizations

Authorization
string
header
required

Chave de API da Arara (ara_live_...), enviada no header Authorization: Bearer ara_live_.... Crie e gerencie as chaves no painel: https://app.ararahq.com/dashboard/apikeys. O valor completo aparece uma única vez, na criação.

Path Parameters

id
string<uuid>
required

ID do template (UUID). O nome não é aceito aqui.

Response

Template

id
string<uuid>
required

ID do template (UUID).

name
string
required
formattedName
string
required
category
string
required

Categoria atual. A Meta pode mudar a categoria na revisão.

language
string
required
providerName
string
required
Example:

"GUPSHUP"

providerTemplateId
string
required
providerStatus
string
required

Status de aprovação:

  • PENDING: em revisão.
  • APPROVED: pronto para enviar.
  • REJECTED: reprovado. Veja rejectionReason.
  • PAUSED: pausado pela Meta ou pela proteção automática da Arara. O envio responde 422 TEMPLATE_PAUSED.
  • DISABLED: desativado. O envio responde 422 TEMPLATE_NOT_SENDABLE.
Example:

"APPROVED"

availableForSending
boolean
required

false quando o template foi aprovado em um número que a organização não usa mais. Recrie o template no número ativo.

structureJson
object
required
createdAt
string<date-time>
required
originalCategory
string | null

Categoria pedida na criação.

rejectionReason
string | null
unavailableReason
string | null
bodyPreview
string | null

Corpo do template, com os marcadores de variável.

usageGuide
object | null
variablesSchema
object | null

Exemplos por número da variável.

updatedAt
string<date-time> | null