Skip to main content
PATCH
Editar modelo de mensagem

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string
required

ID do template

Body

application/json
name
string
description
string | null
items
object[]
Minimum array length: 1
header
object
body
string
Maximum string length: 1024
Maximum string length: 60
buttons
object[]
Maximum array length: 10
variables
object[]
metaTemplateName
string
Maximum string length: 512
Pattern: ^[a-z0-9_]+$
category
enum<string>
Available options:
MARKETING,
UTILITY
language
string

Response

id
string
required
name
string
required
description
string | null
required
isOfficial
boolean
required
metaTemplateStatus
string | null
required
items
object[]
required
commonVariables
object[]
required

Variáveis manuais que devem ser informadas em commonVariables ao iniciar uma campanha.

createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
updatedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
metaTemplateName
string | null
required
category
string | null
required
language
string | null
required
metaRejectedReason
string | null
required
body
string | null
required
header
object
required
buttons
object[]
required
variables
object[]
required