Skip to main content
POST
Criar evento de calendário

Path Parameters

instance_id
string
required

Id da instância (dashboard › instância › Credenciais).

token
string
required

Token da instância. Trate como senha.

Body

application/json
phone
string
required

Chat de destino: número só dígitos com DDI e DDD (5511988887777), grupo (<id>-group), canal (<id>@newsletter), LID (<id>@lid) ou status@broadcast.

Minimum string length: 1
Pattern: ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
name
string
required
Required string length: 1 - 256
start_at
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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
description
string
Maximum string length: 2048
end_at
string<date-time>
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|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
location
object
extra_guests_allowed
boolean
reply_to_message_id
string

Id da mensagem a citar (responder), no mesmo chat.

Minimum string length: 1
mentioned
string[]

Números a mencionar; cada um precisa aparecer no texto como @<número>.

Maximum array length: 500
Minimum string length: 1
Pattern: ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
mention_all
boolean

Grupos: menciona todos os participantes.

delay_message
number

Segundos (0–15) de espera antes de enviar, substituindo o intervalo aleatório da instância (delay_message_min_ms/max_ms).

Required range: 0 <= x <= 15
delay_typing
number

Segundos (0–15) mostrando "digitando…" (ou "gravando…" em voice notes) antes de enviar. Padrão 0.

Required range: 0 <= x <= 15

Response

Evento enfileirado.

id
string
required
message_id
string
required
wabox_id
string
required
status
enum<string>
required
Available options:
queued