ARararahq
Templates

Consultar template

Changed on

id é UUID. Passar o nome no lugar do ID responde 400 INVALID_PATH_PARAM. Para buscar por nome, use GET /v1/templates?name=. Permissão: READ.

get/v1/templates/{id}

Request

Path parameters

idstring uuid required

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

Response

Template

idstring uuid required

ID do template (UUID).

namestring required
formattedNamestring required
categorystring required

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

originalCategorystring nullable

Categoria pedida na criação.

languagestring required
providerNamestring required
providerTemplateIdstring required
providerStatusstring 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.
rejectionReasonstring nullable
availableForSendingboolean 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.

unavailableReasonstring nullable
bodyPreviewstring nullable

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

structureJsonobject required
usageGuideobject nullable
variablesSchemaobject nullable

Exemplos por número da variável.

createdAtstring date-time required
updatedAtstring date-time nullable

Example response

{
  "id": "a7f3c1e2-4b5d-6789-abcd-ef0123456789",
  "name": "pedido_confirmado",
  "formattedName": "pedido_confirmado",
  "category": "UTILITY",
  "originalCategory": "UTILITY",
  "language": "pt_BR",
  "providerName": "GUPSHUP",
  "providerTemplateId": "4c1f0e9a-2b3d-4e5f-8a6b-7c8d9e0f1a2b",
  "providerStatus": "PENDING",
  "rejectionReason": null,
  "availableForSending": true,
  "unavailableReason": null,
  "bodyPreview": "Oi {{1}}, seu pedido {{2}} foi confirmado. Total: R$ {{3}}.",
  "structureJson": {},
  "usageGuide": {
    "message": "Use o objeto 'variables' no envio da mensagem para substituir os placeholders.",
    "endpoint": "POST /v1/messages"
  },
  "variablesSchema": {
    "1": "João",
    "2": "12345",
    "3": "147,90"
  },
  "createdAt": "2026-09-15T14:30:00Z",
  "updatedAt": null
}

Changes

  • d576cd28afc0Revision changes
    • info

      api tag Templates added

    • info

      api tag templates removed

    • info

      added the non-success response with the status

  • 372d8c2e735dRevision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property became optional for the status

    • breaking

      the response's property type changed from object to string for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response body anyOf list for the response status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status